Reservation Station API

<back to all web services

UpdateProfile

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

public class UpdateProfile : ApiServiceRequest
{
    public var emailAddress:String
    public var mobileNumber:String
    public var name:String
    public var venueCustomFields:[VenueCustomField] = []

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

    private enum CodingKeys : String, CodingKey {
        case emailAddress
        case mobileNumber
        case name
        case venueCustomFields
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        emailAddress = try container.decodeIfPresent(String.self, forKey: .emailAddress)
        mobileNumber = try container.decodeIfPresent(String.self, forKey: .mobileNumber)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        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 emailAddress != nil { try container.encode(emailAddress, forKey: .emailAddress) }
        if mobileNumber != nil { try container.encode(mobileNumber, forKey: .mobileNumber) }
        if name != nil { try container.encode(name, forKey: .name) }
        if venueCustomFields.count > 0 { try container.encode(venueCustomFields, forKey: .venueCustomFields) }
    }
}

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

public class UpdateProfileResponse : ApiServiceResponse
{
    public var emailAddress:String
    public var mobileNumber:String
    public var name:String
    public var venueCustomFields:[VenueCustomField] = []

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

    private enum CodingKeys : String, CodingKey {
        case emailAddress
        case mobileNumber
        case name
        case venueCustomFields
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        emailAddress = try container.decodeIfPresent(String.self, forKey: .emailAddress)
        mobileNumber = try container.decodeIfPresent(String.self, forKey: .mobileNumber)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        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 emailAddress != nil { try container.encode(emailAddress, forKey: .emailAddress) }
        if mobileNumber != nil { try container.encode(mobileNumber, forKey: .mobileNumber) }
        if name != nil { try container.encode(name, forKey: .name) }
        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(){}
}


Swift UpdateProfile 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 /user/profile HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"emailAddress":"String","mobileNumber":"String","name":"String","venueCustomFields":[{"venueName":"String","venueId":0,"fields":[{"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

{"emailAddress":"String","mobileNumber":"String","name":"String","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":{}}