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