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

            <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

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

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

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"InstructorId":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeAvailability":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"InstructorSchedule":[{}],"ScheduleByInstructor":[{"InstructorInfo":{"Id":0,"Name":"String","Email":"String","Topic":"String","AvailabilityInfo":{"Sunday":false,"Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false}},"InstructorSchedule":[{}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}