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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AvailabilityInfo
{
    // @DataMember
    public StartTime: string;

    // @DataMember
    public StartTimeString: string;

    // @DataMember
    public Length: number;

    // @DataMember
    public InstructorId: number;

    // @DataMember
    public LocationId: number;

    public constructor(init?: Partial<AvailabilityInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DayTimeInfoObj
{
    // @DataMember
    public WeekDayInt: number;

    // @DataMember
    public WeekDay: string;

    // @DataMember
    public StartTime: string;

    // @DataMember
    public StartTimeString: string;

    public constructor(init?: Partial<DayTimeInfoObj>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GroupClassInfo
{
    // @DataMember
    public DayTimeInfo: DayTimeInfoObj[];

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public Guid: string;

    // @DataMember
    public Length: number;

    // @DataMember
    public InstructorId: number;

    // @DataMember
    public LocationId: number;

    // @DataMember
    public ClassName: string;

    // @DataMember
    public ClassDesc: string;

    // @DataMember
    public ClassSummary: string;

    // @DataMember
    public MaxClassMembers: number;

    // @DataMember
    public CurrentClassMembers: number;

    // @DataMember
    public Notes: string;

    public constructor(init?: Partial<GroupClassInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TimeIncrementByInstructor
{
    // @DataMember
    public InstructorId: number;

    // @DataMember
    public TimeIncrement: number;

    public constructor(init?: Partial<TimeIncrementByInstructor>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetSchedulingCalendarResponse extends BaseResponse
{
    // @DataMember
    public Availabilities: AvailabilityInfo[];

    // @DataMember
    public GroupClasses: GroupClassInfo[];

    // @DataMember
    public TimeIncrement: number;

    // @DataMember
    public TimeIncrementsByInstructor: TimeIncrementByInstructor[];

    public constructor(init?: Partial<GetSchedulingCalendarResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetSchedulingCalendarRequires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past. */
// @DataContract
export class GetSchedulingCalendarRequest extends BaseRequest
{
    /** @description The type of lessons to get a schedule for. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The type of lessons to get a schedule for.", Format="int64", IsRequired=true, Name="TypeId", ParameterType="query")
    public TypeId: number;

    /** @description If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.", Format="date", Name="DateFrom", ParameterType="query")
    public DateFrom: string;

    /** @description If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.", Format="date", Name="DateTo", ParameterType="query")
    public DateTo: string;

    /** @description If sent, only lessons taught by the sent instructor will be returned. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only lessons taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
    public InstructorId?: number;

    /** @description If sent, lessons taught at the sent location will be returned. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, lessons taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
    public LocationId?: number;

    public constructor(init?: Partial<GetSchedulingCalendarRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}