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 java.io.InputStream
import net.servicestack.client.*


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

    @DataMember
    open var DateTo:Date? = null

    @DataMember
    open var TimeFrom:Date? = null

    @DataMember
    open var TimeTo:Date? = null

    @DataMember
    open var Course:String? = null

    @DataMember
    open var Location:String? = null

    @DataMember
    open var WebId:String? = null

    @DataMember
    open var SlotsRequired:Long? = null

    @DataMember
    open var ShowOpenSlots:Boolean? = null

    @DataMember
    open var ShowReservedSlots:Boolean? = null

    @DataMember
    open var Show9HoleSlots:Boolean? = null

    @DataMember
    open var Show18HoleSlots:Boolean? = null

    @DataMember
    open var ShowFront9:Boolean? = null

    @DataMember
    open var ShowBack9:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token: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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

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

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

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

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

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

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

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

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

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

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

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

    @DataMember
    open var DateTime:Date? = null

    @DataMember
    open var Cost:BigDecimal? = null

    @DataMember
    open var Cost2:BigDecimal? = null

    @DataMember
    open var Cost3:BigDecimal? = null

    @DataMember
    open var SlotsOpen:Int? = null

    @DataMember
    open var MinSlots:Int? = null

    @DataMember
    open var Course:String? = null

    @DataMember
    open var CourseTopic:String? = null

    @DataMember
    open var Location:String? = null

    @DataMember
    open var Note:String? = null

    @DataMember
    open var Has18Holes:Boolean? = null

    @DataMember
    open var WebId:String? = null

    @DataMember
    open var StartingOnBack9:Boolean? = null
}

Kotlin GetTeeSlotsRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TimeFrom":"0001-01-01T00:00:00.0000000","TimeTo":"0001-01-01T00:00:00.0000000","Course":"String","Location":"String","WebId":"String","SlotsRequired":0,"ShowOpenSlots":false,"ShowReservedSlots":false,"Show9HoleSlots":false,"Show18HoleSlots":false,"ShowFront9":false,"ShowBack9":false,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TeeSlots":[{"Id":0,"Cost":0,"Cost2":0,"Cost3":0,"SlotsOpen":0,"MinSlots":0,"Course":"String","CourseTopic":"String","Location":"String","Note":"String","Has18Holes":false,"WebId":"String","StartingOnBack9":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}