AIM Web Services

<back to all web services

GetInstructorScheduleRequest

GetInstructorSchedule
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST, GET/api/GetInstructorSchedule
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class ScheduleGeneric
            Public Sub New()
                Students = New List(Of StudentInfoScheduleGeneric)
            End Sub

            <DataMember>
            Public Overridable Property IsAvailability As Boolean

            <DataMember>
            Public Overridable Property Location As String

            <DataMember>
            Public Overridable Property StartTime As Date

            <DataMember>
            Public Overridable Property EndTime As Date

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property ApptDesc As String

            <DataMember>
            Public Overridable Property Color As String

            <DataMember>
            Public Overridable Property Area As String

            <DataMember>
            Public Overridable Property Virtual As Boolean

            <DataMember>
            Public Overridable Property Students As List(Of StudentInfoScheduleGeneric)
        End Class

        <DataContract>
        Public Partial Class StudentInfoGeneric
            <DataMember>
            Public Overridable Property StudentName As String

            <DataMember>
            Public Overridable Property CustomerName As String

            <DataMember>
            Public Overridable Property CustomerNumber As String

            <DataMember>
            Public Overridable Property CustomerEmail As String
        End Class

        <DataContract>
        Public Partial Class StudentInfoScheduleGeneric
            Inherits StudentInfoGeneric
            <DataMember>
            Public Overridable Property ClassMemberId As Long

            <DataMember>
            Public Overridable Property MarkedPresent As Boolean

            <DataMember>
            Public Overridable Property MarkedAbsent As Boolean
        End Class
    End Namespace

    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

            '''<Summary>
            '''The OAuthToken token return by AeServices30
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The OAuthToken token return by AeServices30", IsRequired:=true, Name:="OAuthToken", ParameterType:="Header")>
            Public Overridable Property OAuthToken As String

            '''<Summary>
            '''The Device ID of the Mobile Device. Not used for non-mobile devices.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        '''<Summary>
        '''GetInstructorScheduleRequires active-e Lesson Scheduling Service
        '''</Summary>
        <DataContract>
        Public Partial Class GetInstructorScheduleRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property InstructorId As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property DateFrom As Nullable(Of Date)

            <DataMember>
            Public Overridable Property DateTo As Nullable(Of Date)

            <DataMember>
            Public Overridable Property IncludeAvailability As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class GetInstructorScheduleResponse
            Inherits BaseResponse
            Public Sub New()
                InstructorSchedule = New List(Of ScheduleGeneric)
                ScheduleByInstructor = New List(Of ScheduleByInstructor)
            End Sub

            <DataMember>
            Public Overridable Property InstructorSchedule As List(Of ScheduleGeneric)

            <DataMember>
            Public Overridable Property InstructorTimeInfo As InstructorTimeInfo

            <DataMember>
            Public Overridable Property ScheduleByInstructor As List(Of ScheduleByInstructor)
        End Class

        <DataContract>
        Public Partial Class InstructorTimeInfo
            <DataMember>
            Public Overridable Property StartHour As Integer

            <DataMember>
            Public Overridable Property StartMinute As Integer

            <DataMember>
            Public Overridable Property EndHour As Integer

            <DataMember>
            Public Overridable Property EndMinute As Integer

            <DataMember>
            Public Overridable Property Increment As Integer
        End Class

        <DataContract>
        Public Partial Class ScheduleByInstructor
            Public Sub New()
                InstructorSchedule = New List(Of ScheduleGeneric)
            End Sub

            <DataMember>
            Public Overridable Property InstructorInfo As InstructorInfo

            <DataMember>
            Public Overridable Property InstructorSchedule As List(Of ScheduleGeneric)

            <DataMember>
            Public Overridable Property InstructorTimeInfo As InstructorTimeInfo
        End Class
    End Namespace
End Namespace

VB.NET GetInstructorScheduleRequest 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.

POST /api/GetInstructorSchedule HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetInstructorScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <IncludeAvailability>false</IncludeAvailability>
  <InstructorId>0</InstructorId>
</GetInstructorScheduleRequest>

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

<GetInstructorScheduleResponse 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>
  <InstructorSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScheduleGeneric i:nil="true" />
  </InstructorSchedule>
  <InstructorTimeInfo i:nil="true" />
  <ScheduleByInstructor>
    <ScheduleByInstructor>
      <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>
      </InstructorInfo>
      <InstructorSchedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:ScheduleGeneric i:nil="true" />
      </InstructorSchedule>
      <InstructorTimeInfo i:nil="true" />
    </ScheduleByInstructor>
  </ScheduleByInstructor>
</GetInstructorScheduleResponse>