AIM Web Services

<back to all web services

GetSchedulingCalendarRequest

GetSchedulingCalendar
Requires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.

The following routes are available for this service:
GET/api/GetSchedulingCalendar
GET/api/GetSchedulingCalender
"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 AvailabilityInfo {
    /** @param {{StartTime?:string,StartTimeString?:string,Length?:number,InstructorId?:number,LocationId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StartTime;
    /** @type {string} */
    StartTimeString;
    /** @type {number} */
    Length;
    /** @type {number} */
    InstructorId;
    /** @type {number} */
    LocationId;
}
export class DayTimeInfoObj {
    /** @param {{WeekDayInt?:number,WeekDay?:string,StartTime?:string,StartTimeString?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WeekDayInt;
    /** @type {string} */
    WeekDay;
    /** @type {string} */
    StartTime;
    /** @type {string} */
    StartTimeString;
}
export class GroupClassInfo {
    /** @param {{DayTimeInfo?:DayTimeInfoObj[],StartDate?:string,EndDate?:string,Guid?:string,Length?:number,InstructorId?:number,LocationId?:number,ClassName?:string,ClassDesc?:string,ClassSummary?:string,MaxClassMembers?:number,CurrentClassMembers?:number,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DayTimeInfoObj[]} */
    DayTimeInfo;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {string} */
    Guid;
    /** @type {number} */
    Length;
    /** @type {number} */
    InstructorId;
    /** @type {number} */
    LocationId;
    /** @type {string} */
    ClassName;
    /** @type {string} */
    ClassDesc;
    /** @type {string} */
    ClassSummary;
    /** @type {number} */
    MaxClassMembers;
    /** @type {number} */
    CurrentClassMembers;
    /** @type {string} */
    Notes;
}
export class TimeIncrementByInstructor {
    /** @param {{InstructorId?:number,TimeIncrement?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    InstructorId;
    /** @type {number} */
    TimeIncrement;
}
export class GetSchedulingCalendarResponse extends BaseResponse {
    /** @param {{Availabilities?:AvailabilityInfo[],GroupClasses?:GroupClassInfo[],TimeIncrement?:number,TimeIncrementsByInstructor?:TimeIncrementByInstructor[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AvailabilityInfo[]} */
    Availabilities;
    /** @type {GroupClassInfo[]} */
    GroupClasses;
    /** @type {number} */
    TimeIncrement;
    /** @type {TimeIncrementByInstructor[]} */
    TimeIncrementsByInstructor;
}
export class GetSchedulingCalendarRequest extends BaseRequest {
    /** @param {{TypeId?:number,DateFrom?:string,DateTo?:string,InstructorId?:number,LocationId?:number,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description The type of lessons to get a schedule for. */
    TypeId;
    /**
     * @type {string}
     * @description If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used. */
    DateFrom;
    /**
     * @type {string}
     * @description If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used. */
    DateTo;
    /**
     * @type {?number}
     * @description If sent, only lessons taught by the sent instructor will be returned. */
    InstructorId;
    /**
     * @type {?number}
     * @description If sent, lessons taught at the sent location will be returned. */
    LocationId;
}

JavaScript GetSchedulingCalendarRequest 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/GetSchedulingCalendar HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Availabilities":[{"StartTimeString":"1/1/0001 12:00:00 AM","Length":0,"InstructorId":0,"LocationId":0}],"GroupClasses":[{"DayTimeInfo":[{"WeekDayInt":0,"WeekDay":"String","StartTimeString":"1/1/0001 12:00:00 AM"}],"Guid":"00000000000000000000000000000000","Length":0,"InstructorId":0,"LocationId":0,"ClassName":"String","ClassDesc":"String","ClassSummary":"String","MaxClassMembers":0,"CurrentClassMembers":0,"Notes":"String"}],"TimeIncrement":0,"TimeIncrementsByInstructor":[{"InstructorId":0,"TimeIncrement":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}