AIM Web Services

<back to all web services

GetSchedulingInstructorsRequest

GetSchedulingInstructors
Requires active-e Lesson Scheduling Service

"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /**
     * @type {string}
     * @description The OAuthToken token return by AeServices30 */
    OAuthToken;
    /**
     * @type {string}
     * @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    DeviceId;
    /**
     * @type {string}
     * @description An identifier for your integration */
    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 InstructorAvailabilityInfo {
    /** @param {{Sunday?:boolean,Monday?:boolean,Tuesday?:boolean,Wednesday?:boolean,Thursday?:boolean,Friday?:boolean,Saturday?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Sunday;
    /** @type {boolean} */
    Monday;
    /** @type {boolean} */
    Tuesday;
    /** @type {boolean} */
    Wednesday;
    /** @type {boolean} */
    Thursday;
    /** @type {boolean} */
    Friday;
    /** @type {boolean} */
    Saturday;
}
export class InstructorInfo {
    /** @param {{Id?:number,Name?:string,Email?:string,Topic?:string,AvailabilityInfo?:InstructorAvailabilityInfo}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Email;
    /** @type {string} */
    Topic;
    /** @type {InstructorAvailabilityInfo} */
    AvailabilityInfo;
}
export class GetSchedulingInstructorsResponse extends BaseResponse {
    /** @param {{Instructors?:InstructorInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {InstructorInfo[]} */
    Instructors;
}
export class GetSchedulingInstructorsRequest extends BaseRequest {
    /** @param {{InstructorId?:number,GroupingId?:number,TypeId?:number,LocationId?:number,IncludeAvailabilityInfo?:boolean,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Instructor ID to lookup. If sent, other parameters will be ignored. */
    InstructorId;
    /**
     * @type {?number}
     * @description If sent, only instructors who teach lessons with the passed grouping will be returned. */
    GroupingId;
    /**
     * @type {?number}
     * @description If sent, only instructors who teach lessons with the passed type will be returned. */
    TypeId;
    /**
     * @type {?number}
     * @description If sent, only instructors who have an availability record at the passed location will be returned. */
    LocationId;
    /**
     * @type {boolean}
     * @description If true, basic Availability Info will be included in the response */
    IncludeAvailabilityInfo;
}

JavaScript GetSchedulingInstructorsRequest DTOs

GET /api/GetSchedulingInstructors HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingInstructorsResponse 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>
  <Instructors>
    <GetSchedulingInstructorsResponse.InstructorInfo>
      <AvailabilityInfo>
        <Friday>false</Friday>
        <Monday>false</Monday>
        <Saturday>false</Saturday>
        <Sunday>false</Sunday>
        <Thursday>false</Thursday>
        <Tuesday>false</Tuesday>
        <Wednesday>false</Wednesday>
      </AvailabilityInfo>
      <Email>String</Email>
      <Id>0</Id>
      <Name>String</Name>
      <Topic>String</Topic>
    </GetSchedulingInstructorsResponse.InstructorInfo>
  </Instructors>
</GetSchedulingInstructorsResponse>