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.

"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 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,DeviceId?:string,AppId?: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

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

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

<GetSchedulingCalendarResponse 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>
  <Availabilities>
    <GetSchedulingCalendarResponse.AvailabilityInfo>
      <InstructorId>0</InstructorId>
      <Length>0</Length>
      <LocationId>0</LocationId>
      <StartTime>0001-01-01T00:00:00</StartTime>
      <StartTimeString>1/1/0001 12:00:00 AM</StartTimeString>
    </GetSchedulingCalendarResponse.AvailabilityInfo>
  </Availabilities>
  <GroupClasses>
    <GetSchedulingCalendarResponse.GroupClassInfo>
      <ClassDesc>String</ClassDesc>
      <ClassName>String</ClassName>
      <ClassSummary>String</ClassSummary>
      <CurrentClassMembers>0</CurrentClassMembers>
      <DayTimeInfo>
        <GetSchedulingCalendarResponse.DayTimeInfoObj>
          <StartTime>0001-01-01T00:00:00</StartTime>
          <StartTimeString>1/1/0001 12:00:00 AM</StartTimeString>
          <WeekDay>String</WeekDay>
          <WeekDayInt>0</WeekDayInt>
        </GetSchedulingCalendarResponse.DayTimeInfoObj>
      </DayTimeInfo>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <InstructorId>0</InstructorId>
      <Length>0</Length>
      <LocationId>0</LocationId>
      <MaxClassMembers>0</MaxClassMembers>
      <Notes>String</Notes>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </GetSchedulingCalendarResponse.GroupClassInfo>
  </GroupClasses>
  <TimeIncrement>0</TimeIncrement>
  <TimeIncrementsByInstructor>
    <GetSchedulingCalendarResponse.TimeIncrementByInstructor>
      <InstructorId>0</InstructorId>
      <TimeIncrement>0</TimeIncrement>
    </GetSchedulingCalendarResponse.TimeIncrementByInstructor>
  </TimeIncrementsByInstructor>
</GetSchedulingCalendarResponse>