AIM Web Services

<back to all web services

GetTeeSlotsRequest

GetTeeSlots
Requires active-e Tee-Sheet Service

The following routes are available for this service:
POST, GET/api/GetTeeSlots
import Foundation
import ServiceStack

/**
* GetTeeSlotsRequires active-e Tee-Sheet Service
*/
// @DataContract
public class GetTeeSlotsRequest : BaseSecureRequest
{
    // @DataMember
    public var dateFrom:Date

    // @DataMember
    public var dateTo:Date

    // @DataMember
    public var timeFrom:Date?

    // @DataMember
    public var timeTo:Date?

    // @DataMember
    public var course:String

    // @DataMember
    public var location:String

    // @DataMember
    public var webId:String

    // @DataMember
    public var slotsRequired:Int?

    // @DataMember
    public var showOpenSlots:Bool?

    // @DataMember
    public var showReservedSlots:Bool?

    // @DataMember
    public var show9HoleSlots:Bool?

    // @DataMember
    public var show18HoleSlots:Bool?

    // @DataMember
    public var showFront9:Bool?

    // @DataMember
    public var showBack9:Bool?

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

    private enum CodingKeys : String, CodingKey {
        case dateFrom
        case dateTo
        case timeFrom
        case timeTo
        case course
        case location
        case webId
        case slotsRequired
        case showOpenSlots
        case showReservedSlots
        case show9HoleSlots
        case show18HoleSlots
        case showFront9
        case showBack9
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dateFrom = try container.decodeIfPresent(Date.self, forKey: .dateFrom)
        dateTo = try container.decodeIfPresent(Date.self, forKey: .dateTo)
        timeFrom = try container.decodeIfPresent(Date.self, forKey: .timeFrom)
        timeTo = try container.decodeIfPresent(Date.self, forKey: .timeTo)
        course = try container.decodeIfPresent(String.self, forKey: .course)
        location = try container.decodeIfPresent(String.self, forKey: .location)
        webId = try container.decodeIfPresent(String.self, forKey: .webId)
        slotsRequired = try container.decodeIfPresent(Int.self, forKey: .slotsRequired)
        showOpenSlots = try container.decodeIfPresent(Bool.self, forKey: .showOpenSlots)
        showReservedSlots = try container.decodeIfPresent(Bool.self, forKey: .showReservedSlots)
        show9HoleSlots = try container.decodeIfPresent(Bool.self, forKey: .show9HoleSlots)
        show18HoleSlots = try container.decodeIfPresent(Bool.self, forKey: .show18HoleSlots)
        showFront9 = try container.decodeIfPresent(Bool.self, forKey: .showFront9)
        showBack9 = try container.decodeIfPresent(Bool.self, forKey: .showBack9)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if dateFrom != nil { try container.encode(dateFrom, forKey: .dateFrom) }
        if dateTo != nil { try container.encode(dateTo, forKey: .dateTo) }
        if timeFrom != nil { try container.encode(timeFrom, forKey: .timeFrom) }
        if timeTo != nil { try container.encode(timeTo, forKey: .timeTo) }
        if course != nil { try container.encode(course, forKey: .course) }
        if location != nil { try container.encode(location, forKey: .location) }
        if webId != nil { try container.encode(webId, forKey: .webId) }
        if slotsRequired != nil { try container.encode(slotsRequired, forKey: .slotsRequired) }
        if showOpenSlots != nil { try container.encode(showOpenSlots, forKey: .showOpenSlots) }
        if showReservedSlots != nil { try container.encode(showReservedSlots, forKey: .showReservedSlots) }
        if show9HoleSlots != nil { try container.encode(show9HoleSlots, forKey: .show9HoleSlots) }
        if show18HoleSlots != nil { try container.encode(show18HoleSlots, forKey: .show18HoleSlots) }
        if showFront9 != nil { try container.encode(showFront9, forKey: .showFront9) }
        if showBack9 != nil { try container.encode(showBack9, forKey: .showBack9) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

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

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

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

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

// @DataContract
public class BaseRequest : Codable
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class GetTeeSlotsResponse : BaseResponse
{
    // @DataMember
    public var teeSlots:[TeeSlotGeneric] = []

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

    private enum CodingKeys : String, CodingKey {
        case teeSlots
    }

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

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

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public var domainName:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class TeeSlotGeneric : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var dateTime:Date

    // @DataMember
    public var cost:Double

    // @DataMember
    public var cost2:Double

    // @DataMember
    public var cost3:Double

    // @DataMember
    public var slotsOpen:Int

    // @DataMember
    public var minSlots:Int

    // @DataMember
    public var course:String

    // @DataMember
    public var courseTopic:String

    // @DataMember
    public var location:String

    // @DataMember
    public var note:String

    // @DataMember
    public var has18Holes:Bool

    // @DataMember
    public var webId:String

    // @DataMember
    public var startingOnBack9:Bool

    required public init(){}
}

Swift GetTeeSlotsRequest 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 /api/GetTeeSlots HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetTeeSlotsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Course>String</Course>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <Location>String</Location>
  <Show18HoleSlots>false</Show18HoleSlots>
  <Show9HoleSlots>false</Show9HoleSlots>
  <ShowBack9>false</ShowBack9>
  <ShowFront9>false</ShowFront9>
  <ShowOpenSlots>false</ShowOpenSlots>
  <ShowReservedSlots>false</ShowReservedSlots>
  <SlotsRequired>0</SlotsRequired>
  <TimeFrom>0001-01-01T00:00:00</TimeFrom>
  <TimeTo>0001-01-01T00:00:00</TimeTo>
  <WebId>String</WebId>
</GetTeeSlotsRequest>

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

<GetTeeSlotsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <TeeSlots xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:TeeSlotGeneric>
      <d2p1:Cost>0</d2p1:Cost>
      <d2p1:Cost2>0</d2p1:Cost2>
      <d2p1:Cost3>0</d2p1:Cost3>
      <d2p1:Course>String</d2p1:Course>
      <d2p1:CourseTopic>String</d2p1:CourseTopic>
      <d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
      <d2p1:Has18Holes>false</d2p1:Has18Holes>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:MinSlots>0</d2p1:MinSlots>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:SlotsOpen>0</d2p1:SlotsOpen>
      <d2p1:StartingOnBack9>false</d2p1:StartingOnBack9>
      <d2p1:WebId>String</d2p1:WebId>
    </d2p1:TeeSlotGeneric>
  </TeeSlots>
</GetTeeSlotsResponse>