| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Instructors":[{"Id":0,"Name":"String","Email":"String","Topic":"String","AvailabilityInfo":{"Sunday":false,"Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}