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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class TeeSlotGeneric {
    /** @param {{Id?:number,DateTime?:string,Cost?:number,Cost2?:number,Cost3?:number,SlotsOpen?:number,MinSlots?:number,Course?:string,CourseTopic?:string,Location?:string,Note?:string,Has18Holes?:boolean,WebId?:string,StartingOnBack9?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    DateTime;
    /** @type {number} */
    Cost;
    /** @type {number} */
    Cost2;
    /** @type {number} */
    Cost3;
    /** @type {number} */
    SlotsOpen;
    /** @type {number} */
    MinSlots;
    /** @type {string} */
    Course;
    /** @type {string} */
    CourseTopic;
    /** @type {string} */
    Location;
    /** @type {string} */
    Note;
    /** @type {boolean} */
    Has18Holes;
    /** @type {string} */
    WebId;
    /** @type {boolean} */
    StartingOnBack9;
}
export class GetTeeSlotsResponse extends BaseResponse {
    /** @param {{TeeSlots?:TeeSlotGeneric[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {TeeSlotGeneric[]} */
    TeeSlots;
}
export class GetTeeSlotsRequest extends BaseSecureRequest {
    /** @param {{DateFrom?:string,DateTo?:string,TimeFrom?:string,TimeTo?:string,Course?:string,Location?:string,WebId?:string,SlotsRequired?:number,ShowOpenSlots?:boolean,ShowReservedSlots?:boolean,Show9HoleSlots?:boolean,Show18HoleSlots?:boolean,ShowFront9?:boolean,ShowBack9?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
    /** @type {?string} */
    TimeFrom;
    /** @type {?string} */
    TimeTo;
    /** @type {string} */
    Course;
    /** @type {string} */
    Location;
    /** @type {string} */
    WebId;
    /** @type {?number} */
    SlotsRequired;
    /** @type {?boolean} */
    ShowOpenSlots;
    /** @type {?boolean} */
    ShowReservedSlots;
    /** @type {?boolean} */
    Show9HoleSlots;
    /** @type {?boolean} */
    Show18HoleSlots;
    /** @type {?boolean} */
    ShowFront9;
    /** @type {?boolean} */
    ShowBack9;
}

JavaScript 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"}}