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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

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

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TeeSlotGeneric
{
    // @DataMember
    public Id: number;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public Cost: number;

    // @DataMember
    public Cost2: number;

    // @DataMember
    public Cost3: number;

    // @DataMember
    public SlotsOpen: number;

    // @DataMember
    public MinSlots: number;

    // @DataMember
    public Course: string;

    // @DataMember
    public CourseTopic: string;

    // @DataMember
    public Location: string;

    // @DataMember
    public Note: string;

    // @DataMember
    public Has18Holes: boolean;

    // @DataMember
    public WebId: string;

    // @DataMember
    public StartingOnBack9: boolean;

    public constructor(init?: Partial<TeeSlotGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetTeeSlotsResponse extends BaseResponse
{
    // @DataMember
    public TeeSlots: TeeSlotGeneric[];

    public constructor(init?: Partial<GetTeeSlotsResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetTeeSlotsRequires active-e Tee-Sheet Service */
// @DataContract
export class GetTeeSlotsRequest extends BaseSecureRequest
{
    // @DataMember
    public DateFrom: string;

    // @DataMember
    public DateTo: string;

    // @DataMember
    public TimeFrom?: string;

    // @DataMember
    public TimeTo?: string;

    // @DataMember
    public Course: string;

    // @DataMember
    public Location: string;

    // @DataMember
    public WebId: string;

    // @DataMember
    public SlotsRequired?: number;

    // @DataMember
    public ShowOpenSlots?: boolean;

    // @DataMember
    public ShowReservedSlots?: boolean;

    // @DataMember
    public Show9HoleSlots?: boolean;

    // @DataMember
    public Show18HoleSlots?: boolean;

    // @DataMember
    public ShowFront9?: boolean;

    // @DataMember
    public ShowBack9?: boolean;

    public constructor(init?: Partial<GetTeeSlotsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetTeeSlotsRequest 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 /api/GetTeeSlots HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
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","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}