AIM Web Services

<back to all web services

GetInstructorScheduleRequest

GetInstructorSchedule
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST, GET/api/GetInstructorSchedule
"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 BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    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 StudentInfoGeneric {
    /** @param {{StudentName?:string,CustomerName?:string,CustomerNumber?:string,CustomerEmail?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StudentName;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    CustomerNumber;
    /** @type {string} */
    CustomerEmail;
}
export class StudentInfoScheduleGeneric extends StudentInfoGeneric {
    /** @param {{ClassMemberId?:number,MarkedPresent?:boolean,MarkedAbsent?:boolean,StudentName?:string,CustomerName?:string,CustomerNumber?:string,CustomerEmail?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    ClassMemberId;
    /** @type {boolean} */
    MarkedPresent;
    /** @type {boolean} */
    MarkedAbsent;
}
export class ScheduleGeneric {
    /** @param {{IsAvailability?:boolean,Location?:string,StartTime?:string,EndTime?:string,Desc?:string,ApptDesc?:string,Color?:string,Area?:string,Virtual?:boolean,Students?:StudentInfoScheduleGeneric[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    IsAvailability;
    /** @type {string} */
    Location;
    /** @type {string} */
    StartTime;
    /** @type {string} */
    EndTime;
    /** @type {string} */
    Desc;
    /** @type {string} */
    ApptDesc;
    /** @type {string} */
    Color;
    /** @type {string} */
    Area;
    /** @type {boolean} */
    Virtual;
    /** @type {StudentInfoScheduleGeneric[]} */
    Students;
}
export class InstructorTimeInfo {
    /** @param {{StartHour?:number,StartMinute?:number,EndHour?:number,EndMinute?:number,Increment?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StartHour;
    /** @type {number} */
    StartMinute;
    /** @type {number} */
    EndHour;
    /** @type {number} */
    EndMinute;
    /** @type {number} */
    Increment;
}
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 ScheduleByInstructor {
    /** @param {{InstructorInfo?:InstructorInfo,InstructorSchedule?:ScheduleGeneric[],InstructorTimeInfo?:InstructorTimeInfo}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {InstructorInfo} */
    InstructorInfo;
    /** @type {ScheduleGeneric[]} */
    InstructorSchedule;
    /** @type {InstructorTimeInfo} */
    InstructorTimeInfo;
}
export class GetInstructorScheduleResponse extends BaseResponse {
    /** @param {{InstructorSchedule?:ScheduleGeneric[],InstructorTimeInfo?:InstructorTimeInfo,ScheduleByInstructor?:ScheduleByInstructor[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ScheduleGeneric[]} */
    InstructorSchedule;
    /** @type {InstructorTimeInfo} */
    InstructorTimeInfo;
    /** @type {ScheduleByInstructor[]} */
    ScheduleByInstructor;
}
export class GetInstructorScheduleRequest extends BaseSecureRequest {
    /** @param {{InstructorId?:number,DateFrom?:string,DateTo?:string,IncludeAvailability?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    InstructorId;
    /** @type {?string} */
    DateFrom;
    /** @type {?string} */
    DateTo;
    /** @type {?boolean} */
    IncludeAvailability;
}

JavaScript GetInstructorScheduleRequest 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.

POST /api/GetInstructorSchedule HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InstructorId":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeAvailability":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

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