AIM Web Services

<back to all 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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class BaseRequest
            '''<Summary>
            '''This is your AIM API Key provided by Tri-Tech
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="This is your AIM API Key provided by Tri-Tech", IsRequired:=true, Name:="ApiKey", ParameterType:="header")>
            Public Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        '''<Summary>
        '''GetSchedulingCalendarRequires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.
        '''</Summary>
        <DataContract>
        Public Partial Class GetSchedulingCalendarRequest
            Inherits BaseRequest
            '''<Summary>
            '''The type of lessons to get a schedule for.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The type of lessons to get a schedule for.", Format:="int64", IsRequired:=true, Name:="TypeId", ParameterType:="query")>
            Public Overridable Property TypeId As Long

            '''<Summary>
            '''If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.", Format:="date", Name:="DateFrom", ParameterType:="query")>
            Public Overridable Property DateFrom As String

            '''<Summary>
            '''If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.", Format:="date", Name:="DateTo", ParameterType:="query")>
            Public Overridable Property DateTo As String

            '''<Summary>
            '''If sent, only lessons taught by the sent instructor will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only lessons taught by the sent instructor will be returned.", Format:="int32", Name:="InstructorId", ParameterType:="query")>
            Public Overridable Property InstructorId As Nullable(Of Integer)

            '''<Summary>
            '''If sent, lessons taught at the sent location will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, lessons taught at the sent location will be returned.", Format:="int64", Name:="LocationId", ParameterType:="query")>
            Public Overridable Property LocationId As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class GetSchedulingCalendarResponse
            Inherits BaseResponse
            Public Sub New()
                Availabilities = New List(Of AvailabilityInfo)
                GroupClasses = New List(Of GroupClassInfo)
                TimeIncrementsByInstructor = New List(Of TimeIncrementByInstructor)
            End Sub

            <DataMember>
            Public Overridable Property Availabilities As List(Of AvailabilityInfo)

            <DataMember>
            Public Overridable Property GroupClasses As List(Of GroupClassInfo)

            <DataMember>
            Public Overridable Property TimeIncrement As Integer

            <DataMember>
            Public Overridable Property TimeIncrementsByInstructor As List(Of TimeIncrementByInstructor)

            <DataContract>
            Public Partial Class AvailabilityInfo
                <DataMember>
                Public Overridable Property StartTime As Date

                <DataMember>
                Public Overridable Property StartTimeString As String

                <DataMember>
                Public Overridable Property Length As Integer

                <DataMember>
                Public Overridable Property InstructorId As Integer

                <DataMember>
                Public Overridable Property LocationId As Long
            End Class

            <DataContract>
            Public Partial Class TimeIncrementByInstructor
                <DataMember>
                Public Overridable Property InstructorId As Integer

                <DataMember>
                Public Overridable Property TimeIncrement As Integer
            End Class

            <DataContract>
            Public Partial Class GroupClassInfo
                Public Sub New()
                    DayTimeInfo = New List(Of DayTimeInfoObj)
                End Sub

                <DataMember>
                Public Overridable Property DayTimeInfo As List(Of DayTimeInfoObj)

                <DataMember>
                Public Overridable Property StartDate As Date

                <DataMember>
                Public Overridable Property EndDate As Date

                <DataMember>
                Public Overridable Property Guid As Guid

                <DataMember>
                Public Overridable Property Length As Integer

                <DataMember>
                Public Overridable Property InstructorId As Integer

                <DataMember>
                Public Overridable Property LocationId As Long

                <DataMember>
                Public Overridable Property ClassName As String

                <DataMember>
                Public Overridable Property ClassDesc As String

                <DataMember>
                Public Overridable Property ClassSummary As String

                <DataMember>
                Public Overridable Property MaxClassMembers As Integer

                <DataMember>
                Public Overridable Property CurrentClassMembers As Integer

                <DataMember>
                Public Overridable Property Notes As String
            End Class

            <DataContract>
            Public Partial Class DayTimeInfoObj
                <DataMember>
                Public Overridable Property WeekDayInt As Integer

                <DataMember>
                Public Overridable Property WeekDay As String

                <DataMember>
                Public Overridable Property StartTime As Date

                <DataMember>
                Public Overridable Property StartTimeString As String
            End Class
        End Class
    End Namespace
End Namespace

VB.NET GetSchedulingCalendarRequest DTOs

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>