GalaxyMobile App API

<back to all web services

PickMeUpTimeCheck

Requires Authentication
import Foundation
import ServiceStack

public class PickMeUpTimeCheck : ApiServiceRequest
{
    public var checkDate:String

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

    private enum CodingKeys : String, CodingKey {
        case checkDate
    }

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

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

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, IHasClientId, 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 PickMeUpTimeCheckResponse : ApiServiceResponse
{
    public var minimumMinutes:Int
    public var isPeakTime:Bool
    public var checkDateTooSoon:Bool

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

    private enum CodingKeys : String, CodingKey {
        case minimumMinutes
        case isPeakTime
        case checkDateTooSoon
    }

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

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

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


Swift PickMeUpTimeCheck 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 /json/reply/PickMeUpTimeCheck HTTP/1.1 
Host: galaxymobile.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CheckDate":"String","ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MinimumMinutes":0,"IsPeakTime":false,"CheckDateTooSoon":false,"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}