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 java.math.*
import java.util.*
import net.servicestack.client.*


/**
* GetTeeSlotsRequires active-e Tee-Sheet Service
*/
@DataContract
open class GetTeeSlotsRequest : BaseSecureRequest()
{
    @DataMember
    var DateFrom:Date? = null

    @DataMember
    var DateTo:Date? = null

    @DataMember
    var TimeFrom:Date? = null

    @DataMember
    var TimeTo:Date? = null

    @DataMember
    var Course:String? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var WebId:String? = null

    @DataMember
    var SlotsRequired:Long? = null

    @DataMember
    var ShowOpenSlots:Boolean? = null

    @DataMember
    var ShowReservedSlots:Boolean? = null

    @DataMember
    var Show9HoleSlots:Boolean? = null

    @DataMember
    var Show18HoleSlots:Boolean? = null

    @DataMember
    var ShowFront9:Boolean? = null

    @DataMember
    var ShowBack9:Boolean? = null
}

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

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

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

@DataContract
open class BaseRequest
{
    /**
    * 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetTeeSlotsResponse : BaseResponse()
{
    @DataMember
    var TeeSlots:ArrayList<TeeSlotGeneric> = ArrayList<TeeSlotGeneric>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

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

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

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

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

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class TeeSlotGeneric
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var DateTime:Date? = null

    @DataMember
    var Cost:BigDecimal? = null

    @DataMember
    var Cost2:BigDecimal? = null

    @DataMember
    var Cost3:BigDecimal? = null

    @DataMember
    var SlotsOpen:Int? = null

    @DataMember
    var MinSlots:Int? = null

    @DataMember
    var Course:String? = null

    @DataMember
    var CourseTopic:String? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var Note:String? = null

    @DataMember
    var Has18Holes:Boolean? = null

    @DataMember
    var WebId:String? = null

    @DataMember
    var StartingOnBack9:Boolean? = null
}

Kotlin 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>