| GET | /api/GetSchedulingCalendar | ||
|---|---|---|---|
| GET | /api/GetSchedulingCalender |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeId | query | integer | Yes | The type of lessons to get a schedule for. |
| DateFrom | query | string | No | If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used. |
| DateTo | query | string | No | If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used. |
| InstructorId | query | integer | No | If sent, only lessons taught by the sent instructor will be returned. |
| LocationId | query | integer | No | If sent, lessons taught at the sent location will be returned. |
| 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 |
|---|---|---|---|---|
| Availabilities | form | List<AvailabilityInfo> | No | |
| GroupClasses | form | List<GroupClassInfo> | No | |
| TimeIncrement | form | int | No | |
| TimeIncrementsByInstructor | form | List<TimeIncrementByInstructor> | 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 |
|---|---|---|---|---|
| StartTime | form | DateTime | No | |
| StartTimeString | form | string | No | |
| Length | form | int | No | |
| InstructorId | form | int | No | |
| LocationId | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayTimeInfo | form | List<DayTimeInfoObj> | No | |
| StartDate | form | DateTime | No | |
| EndDate | form | DateTime | No | |
| Guid | form | Guid | No | |
| Length | form | int | No | |
| InstructorId | form | int | No | |
| LocationId | form | long | No | |
| ClassName | form | string | No | |
| ClassDesc | form | string | No | |
| ClassSummary | form | string | No | |
| MaxClassMembers | form | int | No | |
| CurrentClassMembers | form | int | No | |
| Notes | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WeekDayInt | form | int | No | |
| WeekDay | form | string | No | |
| StartTime | form | DateTime | No | |
| StartTimeString | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InstructorId | form | int | No | |
| TimeIncrement | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}}