AIM Web Services

<back to all web services

GetCoursesRequest

GetCourses
Requires active-e Tee-Sheet Service

The following routes are available for this service:
GET/api/GetCourses

// @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 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 CourseGeneric
{
    // @DataMember
    public Course: string;

    // @DataMember
    public CourseTopic: string;

    // @DataMember
    public Location: string;

    // @DataMember
    public Has18Holes: boolean;

    // @DataMember
    public OnlineBuffer: number;

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

// @DataContract
export class GetCoursesResponse extends BaseResponse
{
    // @DataMember
    public Courses: CourseGeneric[];

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

/** @description GetCoursesRequires active-e Tee-Sheet Service */
// @DataContract
export class GetCoursesRequest extends BaseRequest
{

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

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

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>