Reservation Station API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
import Foundation
import ServiceStack

public class UserLogin : ApiServiceRequest
{
    public var googleIdToken:String
    public var utcOffset:Int
    public var emailAddress:String
    public var displayName:String

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

    private enum CodingKeys : String, CodingKey {
        case googleIdToken
        case utcOffset
        case emailAddress
        case displayName
    }

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

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

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 UserLoginResponse : ApiServiceResponse
{
    public var registrationRequired:Bool
    public var data:LoginData

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

    private enum CodingKeys : String, CodingKey {
        case registrationRequired
        case data
    }

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

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

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 LoginData : Codable
{
    public var systemUserId:Int
    public var name:String
    public var emailAddress:String
    public var mobileNumber:String
    public var refreshToken:String
    public var refreshTokenExpiry:String
    public var venues:[VenueData] = []
    public var venueCustomFields:[VenueCustomField] = []

    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(){}
}

public class UserCustomFieldData : Codable
{
    public var id:String
    public var value:String
    public var name:String
    public var optional:Bool

    required public init(){}
}


Swift UserLogin DTOs

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

HTTP + OTHER

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

POST /user/login HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"googleIdToken":"String","utcOffset":0,"emailAddress":"String","displayName":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"registrationRequired":false,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}