Reservation Station API

<back to all web services

JoinVenue

Requires Authentication
The following routes are available for this service:
POST/venue/join
import Foundation
import ServiceStack

public class JoinVenue : ApiServiceRequest
{
    public var venueCode:String
    public var userCustomFields:[UserCustomFieldData] = []

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

    private enum CodingKeys : String, CodingKey {
        case venueCode
        case userCustomFields
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        venueCode = try container.decodeIfPresent(String.self, forKey: .venueCode)
        userCustomFields = try container.decodeIfPresent([UserCustomFieldData].self, forKey: .userCustomFields) ?? []
    }

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

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 UserCustomFieldData : Codable
{
    public var id:String
    public var value:String
    public var name:String
    public var optional:Bool

    required public init(){}
}

public class JoinVenueResponse : ApiServiceResponse
{
    public var venues:[VenueData] = []
    public var venueCustomFields:[VenueCustomField] = []

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

    private enum CodingKeys : String, CodingKey {
        case venues
        case venueCustomFields
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        venues = try container.decodeIfPresent([VenueData].self, forKey: .venues) ?? []
        venueCustomFields = try container.decodeIfPresent([VenueCustomField].self, forKey: .venueCustomFields) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if venues.count > 0 { try container.encode(venues, forKey: .venues) }
        if venueCustomFields.count > 0 { try container.encode(venueCustomFields, forKey: .venueCustomFields) }
    }
}

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 VenueData : Codable
{
    public var venueId:Int
    public var name:String
    public var registeredDate:String
    public var venueCode:String
    public var isCoordinator:Bool
    public var facilities:[FacilityData] = []
    public var latitude:Double
    public var longitude:Double
    public var hasLocation:Bool
    public var logoUrl:String
    public var leadTime:Int
    public var venueInfo:String
    public var allowGuests:Bool
    public var contactNumber:String

    required public init(){}
}

public class FacilityData : Codable
{
    public var facilityId:Int
    public var facilityGuid:String
    public var name:String
    public var Description:String
    public var nextAvailable:String
    public var hasNextAvailable:Bool
    public var rates:[RatesItem] = []
    public var themeColor:String
    public var bookingNotes:String
    public var leadTime:Int
    public var venueId:Int
    public var allowExtraRequirements:Bool

    required public init(){}
}

public class RatesItem : Codable
{
    public var rate:Double
    public var minutes:Int

    required public init(){}
}

public class VenueCustomField : Codable
{
    public var venueName:String
    public var venueId:Int
    public var fields:[UserCustomFieldData] = []

    required public init(){}
}


Swift JoinVenue DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /venue/join HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"venueCode":"String","userCustomFields":[{"id":"00000000-0000-0000-0000-000000000000","value":"String","name":"String","optional":false}],"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"venues":[{}],"venueCustomFields":[{"venueName":"String","venueId":0,"fields":[{"id":"00000000-0000-0000-0000-000000000000","value":"String","name":"String","optional":false}]}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}