Reservation Station API

<back to all web services

GetGroup

Requires Authentication
The following routes are available for this service:
GET/group/
GET/group/{VenueId}
import Foundation
import ServiceStack

public class GetGroup : ApiServiceRequest
{
    public var venueId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case venueId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        venueId = try container.decodeIfPresent(Int.self, forKey: .venueId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if venueId != nil { try container.encode(venueId, forKey: .venueId) }
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class GetGroupResponse : ApiServiceResponse
{
    public var groupCode:String
    public var groupUsers:[GroupUserData] = []
    public var myGroups:[GroupData] = []
    public var venueName:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case groupCode
        case groupUsers
        case myGroups
        case venueName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        groupCode = try container.decodeIfPresent(String.self, forKey: .groupCode)
        groupUsers = try container.decodeIfPresent([GroupUserData].self, forKey: .groupUsers) ?? []
        myGroups = try container.decodeIfPresent([GroupData].self, forKey: .myGroups) ?? []
        venueName = try container.decodeIfPresent(String.self, forKey: .venueName)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if groupCode != nil { try container.encode(groupCode, forKey: .groupCode) }
        if groupUsers.count > 0 { try container.encode(groupUsers, forKey: .groupUsers) }
        if myGroups.count > 0 { try container.encode(myGroups, forKey: .myGroups) }
        if venueName != nil { try container.encode(venueName, forKey: .venueName) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class GroupUserData : Codable
{
    public var id:Int
    public var userId:Int
    public var name:String

    required public init(){}
}

public class GroupData : Codable
{
    public var id:Int
    public var name:String

    required public init(){}
}


Swift GetGroup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /group/ HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"groupCode":"String","groupUsers":[{}],"myGroups":[{}],"venueName":"String","description":"String","heading":"String","wasSuccessful":false,"modelState":{}}