AIM Web Services

<back to all web services

GetSchedulingInstructorsRequest

GetSchedulingInstructors
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingInstructors
"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 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}} [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

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

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

{"Instructors":[{"Id":0,"Name":"String","Email":"String","Topic":"String","AvailabilityInfo":{"Sunday":false,"Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}