AIM Web Services

<back to all web services

GetSchedulingTypesRequest

GetSchedulingTypes
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingTypes
"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 TypeInfo {
    /** @param {{Id?:number,Desc?:string,Length?:number,Topic?:string,RecurranceType?:string,MembershipType?:string,Rate?:number,GroupingId?:number,GroupingDesc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
    /** @type {number} */
    Length;
    /** @type {string} */
    Topic;
    /** @type {string} */
    RecurranceType;
    /** @type {string} */
    MembershipType;
    /** @type {number} */
    Rate;
    /** @type {?number} */
    GroupingId;
    /** @type {string} */
    GroupingDesc;
}
export class GetSchedulingTypesResponse extends BaseResponse {
    /** @param {{Types?:TypeInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {TypeInfo[]} */
    Types;
}
export class GetSchedulingTypesRequest extends BaseRequest {
    /** @param {{TypeId?:number,GroupingId?:number,InstructorId?:number,LocationId?:number,MembershipType?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Type ID to look up. If sent, all other parameters will be ignored. */
    TypeId;
    /**
     * @type {?number}
     * @description If sent, only types in the sent grouping will be returned. */
    GroupingId;
    /**
     * @type {?number}
     * @description If sent, only types taught by the sent instructor will be returned. */
    InstructorId;
    /**
     * @type {?number}
     * @description If sent, only types taught at the sent location will be returned. */
    LocationId;
    /**
     * @type {string}
     * @description If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned. */
    MembershipType;
}

JavaScript GetSchedulingTypesRequest 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/GetSchedulingTypes HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSchedulingTypesResponse 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>
  <Types>
    <GetSchedulingTypesResponse.TypeInfo>
      <Desc>String</Desc>
      <GroupingDesc>String</GroupingDesc>
      <GroupingId>0</GroupingId>
      <Id>0</Id>
      <Length>0</Length>
      <MembershipType>String</MembershipType>
      <Rate>0</Rate>
      <RecurranceType>String</RecurranceType>
      <Topic>String</Topic>
    </GetSchedulingTypesResponse.TypeInfo>
  </Types>
</GetSchedulingTypesResponse>