Reservation Station API

<back to all web services

UserCheckEmail

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

public class UserCheckEmail : ApiServiceActivityRequest
{
    public var emailAddress:String

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

    private enum CodingKeys : String, CodingKey {
        case emailAddress
    }

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

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

public class ApiServiceActivityRequest : ApiServiceRequest
{
    /**
    * Date that this activitiy took place. ISO 8601
    */
    // @ApiMember(Description="Date that this activitiy took place. ISO 8601", IsRequired=true)
    public var activityDate:String

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

    private enum CodingKeys : String, CodingKey {
        case activityDate
    }

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

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

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 UserCheckEmailResponse : ApiServiceResponse
{
    public var systemUserId:Int

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

    private enum CodingKeys : String, CodingKey {
        case systemUserId
    }

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

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

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 UserCheckEmail DTOs

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

HTTP + XML

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

POST /user/email/ HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserCheckEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <ActivityDate xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ActivityDate>
  <EmailAddress>String</EmailAddress>
</UserCheckEmail>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserCheckEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <SystemUserId>0</SystemUserId>
</UserCheckEmailResponse>