GET | /api/GetCourses |
---|
"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 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 CourseGeneric {
/** @param {{Course?:string,CourseTopic?:string,Location?:string,Has18Holes?:boolean,OnlineBuffer?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Course;
/** @type {string} */
CourseTopic;
/** @type {string} */
Location;
/** @type {boolean} */
Has18Holes;
/** @type {number} */
OnlineBuffer;
}
export class GetCoursesResponse extends BaseResponse {
/** @param {{Courses?:CourseGeneric[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {CourseGeneric[]} */
Courses;
}
export class GetCoursesRequest extends BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript GetCoursesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetCourses HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetCoursesResponse 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> <Courses xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM"> <d2p1:CourseGeneric> <d2p1:Course>String</d2p1:Course> <d2p1:CourseTopic>String</d2p1:CourseTopic> <d2p1:Has18Holes>false</d2p1:Has18Holes> <d2p1:Location>String</d2p1:Location> <d2p1:OnlineBuffer>0</d2p1:OnlineBuffer> </d2p1:CourseGeneric> </Courses> </GetCoursesResponse>