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
GetSchedulingCalendarRequest Parameters:
NameParameterData TypeRequiredDescription
TypeIdqueryintegerYesThe type of lessons to get a schedule for.
DateFromquerystringNoIf sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.
DateToquerystringNoIf sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.
InstructorIdqueryintegerNoIf sent, only lessons taught by the sent instructor will be returned.
LocationIdqueryintegerNoIf sent, lessons taught at the sent location will be returned.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
GetSchedulingCalendarResponse Parameters:
NameParameterData TypeRequiredDescription
AvailabilitiesformList<AvailabilityInfo>No
GroupClassesformList<GroupClassInfo>No
TimeIncrementformintNo
TimeIncrementsByInstructorformList<TimeIncrementByInstructor>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
AvailabilityInfo Parameters:
NameParameterData TypeRequiredDescription
StartTimeformDateTimeNo
StartTimeStringformstringNo
LengthformintNo
InstructorIdformintNo
LocationIdformlongNo
GroupClassInfo Parameters:
NameParameterData TypeRequiredDescription
DayTimeInfoformList<DayTimeInfoObj>No
StartDateformDateTimeNo
EndDateformDateTimeNo
GuidformGuidNo
LengthformintNo
InstructorIdformintNo
LocationIdformlongNo
ClassNameformstringNo
ClassDescformstringNo
ClassSummaryformstringNo
MaxClassMembersformintNo
CurrentClassMembersformintNo
NotesformstringNo
DayTimeInfoObj Parameters:
NameParameterData TypeRequiredDescription
WeekDayIntformintNo
WeekDayformstringNo
StartTimeformDateTimeNo
StartTimeStringformstringNo
TimeIncrementByInstructor Parameters:
NameParameterData TypeRequiredDescription
InstructorIdformintNo
TimeIncrementformintNo

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}