GET | /api/GetSchedulingInstructors |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InstructorId | query | integer | No | Instructor ID to lookup. If sent, other parameters will be ignored. |
GroupingId | query | integer | No | If sent, only instructors who teach lessons with the passed grouping will be returned. |
TypeId | query | integer | No | If sent, only instructors who teach lessons with the passed type will be returned. |
LocationId | query | integer | No | If sent, only instructors who have an availability record at the passed location will be returned. |
IncludeAvailabilityInfo | query | boolean | No | If true, basic Availability Info will be included in the response |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
OAuthToken | header | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Instructors | form | List<InstructorInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | body | BaseResponseResult | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
form | string | No | ||
Topic | form | string | No | |
AvailabilityInfo | form | InstructorAvailabilityInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingInstructors HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetSchedulingInstructorsResponse 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> <Instructors> <GetSchedulingInstructorsResponse.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> </GetSchedulingInstructorsResponse.InstructorInfo> </Instructors> </GetSchedulingInstructorsResponse>