AIM Web Services

GetInstructorScheduleRequest

GetInstructorSchedule
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST, GET	/api/GetInstructorSchedule

**GetInstructorScheduleRequest** Parameters:
Name	Parameter	Data Type	Required
InstructorId	body	int?	No
DateFrom	body	DateTime?	No
DateTo	body	DateTime?	No
IncludeAvailability	body	bool?	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**GetInstructorScheduleResponse** Parameters:
Name	Parameter	Data Type	Required
InstructorSchedule	form	List<ScheduleGeneric>	No
InstructorTimeInfo	form	InstructorTimeInfo	No
ScheduleByInstructor	form	List<ScheduleByInstructor>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**ScheduleGeneric** Parameters:
Name	Parameter	Data Type	Required
IsAvailability	form	bool	No
Location	form	string	No
StartTime	form	DateTime	No
EndTime	form	DateTime	No
Desc	form	string	No
ApptDesc	form	string	No
Color	form	string	No
Area	form	string	No
Virtual	form	bool	No
Students	form	List<StudentInfoScheduleGeneric>	No

**StudentInfoScheduleGeneric** Parameters:
Name	Parameter	Data Type	Required
ClassMemberId	form	long	No
MarkedPresent	form	bool	No
MarkedAbsent	form	bool	No

**StudentInfoGeneric** Parameters:
Name	Parameter	Data Type	Required
StudentName	form	string	No
CustomerName	form	string	No
CustomerNumber	form	string	No
CustomerEmail	form	string	No

**InstructorTimeInfo** Parameters:
Name	Parameter	Data Type	Required
StartHour	form	int	No
StartMinute	form	int	No
EndHour	form	int	No
EndMinute	form	int	No
Increment	form	int	No

**ScheduleByInstructor** Parameters:
Name	Parameter	Data Type	Required
InstructorInfo	form	InstructorInfo	No
InstructorSchedule	form	List<ScheduleGeneric>	No
InstructorTimeInfo	form	InstructorTimeInfo	No

**InstructorInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Email	form	string	No
Topic	form	string	No
AvailabilityInfo	form	InstructorAvailabilityInfo	No

**InstructorAvailabilityInfo** Parameters:
Name	Parameter	Data Type	Required
Sunday	form	bool	No
Monday	form	bool	No
Tuesday	form	bool	No
Wednesday	form	bool	No
Thursday	form	bool	No
Friday	form	bool	No
Saturday	form	bool	No

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetInstructorScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <IncludeAvailability>false</IncludeAvailability>
  <InstructorId>0</InstructorId>
</GetInstructorScheduleRequest>

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

<GetInstructorScheduleResponse 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>
  <InstructorSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScheduleGeneric i:nil="true" />
  </InstructorSchedule>
  <InstructorTimeInfo i:nil="true" />
  <ScheduleByInstructor>
    <ScheduleByInstructor>
      <InstructorInfo>
        <AvailabilityInfo>
          <Friday>false</Friday>
          <Monday>false</Monday>
          <Saturday>false</Saturday>
          <Sunday>false</Sunday>
          <Thursday>false</Thursday>
          <Tuesday>false</Tuesday>
          <Wednesday>false</Wednesday>
        </AvailabilityInfo>
        <Email>String</Email>
        <Id>0</Id>
        <Name>String</Name>
        <Topic>String</Topic>
      </InstructorInfo>
      <InstructorSchedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:ScheduleGeneric i:nil="true" />
      </InstructorSchedule>
      <InstructorTimeInfo i:nil="true" />
    </ScheduleByInstructor>
  </ScheduleByInstructor>
</GetInstructorScheduleResponse>

AIM Web Services

GetInstructorScheduleRequest

GetInstructorSchedule Requires active-e Lesson Scheduling Service

HTTP + XML

GetInstructorSchedule
Requires active-e Lesson Scheduling Service