AIM Web Services

GetSchedulingCalendarRequest

GetSchedulingCalendar
Requires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.

The following routes are available for this service:
GET	/api/GetSchedulingCalendar
GET	/api/GetSchedulingCalender

**GetSchedulingCalendarRequest** Parameters:
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.

**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

**GetSchedulingCalendarResponse** Parameters:
Name	Parameter	Data Type	Required
Availabilities	form	List<AvailabilityInfo>	No
GroupClasses	form	List<GroupClassInfo>	No
TimeIncrement	form	int	No
TimeIncrementsByInstructor	form	List<TimeIncrementByInstructor>	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

**AvailabilityInfo** Parameters:
Name	Parameter	Data Type	Required
StartTime	form	DateTime	No
StartTimeString	form	string	No
Length	form	int	No
InstructorId	form	int	No
LocationId	form	long	No

**GroupClassInfo** Parameters:
Name	Parameter	Data Type	Required
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

**DayTimeInfoObj** Parameters:
Name	Parameter	Data Type	Required
WeekDayInt	form	int	No
WeekDay	form	string	No
StartTime	form	DateTime	No
StartTimeString	form	string	No

**TimeIncrementByInstructor** Parameters:
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 .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.

GET /api/GetSchedulingCalendar HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingCalendarResponse 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>
  <Availabilities>
    <GetSchedulingCalendarResponse.AvailabilityInfo>
      <InstructorId>0</InstructorId>
      <Length>0</Length>
      <LocationId>0</LocationId>
      <StartTime>0001-01-01T00:00:00</StartTime>
      <StartTimeString>1/1/0001 12:00:00 AM</StartTimeString>
    </GetSchedulingCalendarResponse.AvailabilityInfo>
  </Availabilities>
  <GroupClasses>
    <GetSchedulingCalendarResponse.GroupClassInfo>
      <ClassDesc>String</ClassDesc>
      <ClassName>String</ClassName>
      <ClassSummary>String</ClassSummary>
      <CurrentClassMembers>0</CurrentClassMembers>
      <DayTimeInfo>
        <GetSchedulingCalendarResponse.DayTimeInfoObj>
          <StartTime>0001-01-01T00:00:00</StartTime>
          <StartTimeString>1/1/0001 12:00:00 AM</StartTimeString>
          <WeekDay>String</WeekDay>
          <WeekDayInt>0</WeekDayInt>
        </GetSchedulingCalendarResponse.DayTimeInfoObj>
      </DayTimeInfo>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <InstructorId>0</InstructorId>
      <Length>0</Length>
      <LocationId>0</LocationId>
      <MaxClassMembers>0</MaxClassMembers>
      <Notes>String</Notes>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </GetSchedulingCalendarResponse.GroupClassInfo>
  </GroupClasses>
  <TimeIncrement>0</TimeIncrement>
  <TimeIncrementsByInstructor>
    <GetSchedulingCalendarResponse.TimeIncrementByInstructor>
      <InstructorId>0</InstructorId>
      <TimeIncrement>0</TimeIncrement>
    </GetSchedulingCalendarResponse.TimeIncrementByInstructor>
  </TimeIncrementsByInstructor>
</GetSchedulingCalendarResponse>

AIM Web Services

GetSchedulingCalendarRequest

GetSchedulingCalendar Requires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.

HTTP + XML

GetSchedulingCalendar
Requires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.