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
GetInstructorScheduleRequest Parameters:
NameParameterData TypeRequiredDescription
InstructorIdbodyint?No
DateFrombodyDateTime?No
DateTobodyDateTime?No
IncludeAvailabilitybodybool?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNoThe Login Token return by the Security API. Required for secured calls.
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
GetInstructorScheduleResponse Parameters:
NameParameterData TypeRequiredDescription
InstructorScheduleformList<ScheduleGeneric>No
InstructorTimeInfoformInstructorTimeInfoNo
ScheduleByInstructorformList<ScheduleByInstructor>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ScheduleGeneric Parameters:
NameParameterData TypeRequiredDescription
IsAvailabilityformboolNo
LocationformstringNo
StartTimeformDateTimeNo
EndTimeformDateTimeNo
DescformstringNo
ApptDescformstringNo
ColorformstringNo
AreaformstringNo
VirtualformboolNo
StudentsformList<StudentInfoScheduleGeneric>No
StudentInfoScheduleGeneric Parameters:
NameParameterData TypeRequiredDescription
ClassMemberIdformlongNo
MarkedPresentformboolNo
MarkedAbsentformboolNo
StudentInfoGeneric Parameters:
NameParameterData TypeRequiredDescription
StudentNameformstringNo
CustomerNameformstringNo
CustomerNumberformstringNo
CustomerEmailformstringNo
InstructorTimeInfo Parameters:
NameParameterData TypeRequiredDescription
StartHourformintNo
StartMinuteformintNo
EndHourformintNo
EndMinuteformintNo
IncrementformintNo
ScheduleByInstructor Parameters:
NameParameterData TypeRequiredDescription
InstructorInfoformInstructorInfoNo
InstructorScheduleformList<ScheduleGeneric>No
InstructorTimeInfoformInstructorTimeInfoNo
InstructorInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
EmailformstringNo
TopicformstringNo
AvailabilityInfoformInstructorAvailabilityInfoNo
InstructorAvailabilityInfo Parameters:
NameParameterData TypeRequiredDescription
SundayformboolNo
MondayformboolNo
TuesdayformboolNo
WednesdayformboolNo
ThursdayformboolNo
FridayformboolNo
SaturdayformboolNo

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.

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

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

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