AIM Web Services

<back to all web services

GetSchedulingInstructorsRequest

GetSchedulingInstructors
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingInstructors
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

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

        '''<Summary>
        '''GetSchedulingInstructorsRequires active-e Lesson Scheduling Service
        '''</Summary>
        <DataContract>
        Public Partial Class GetSchedulingInstructorsRequest
            Inherits BaseRequest
            '''<Summary>
            '''Instructor ID to lookup. If sent, other parameters will be ignored.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Instructor ID to lookup. If sent, other parameters will be ignored.", Format:="int32", Name:="InstructorId", ParameterType:="query")>
            Public Overridable Property InstructorId As Nullable(Of Integer)

            '''<Summary>
            '''If sent, only instructors who teach lessons with the passed grouping will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only instructors who teach lessons with the passed grouping will be returned.", Format:="int64", Name:="GroupingId", ParameterType:="query")>
            Public Overridable Property GroupingId As Nullable(Of Long)

            '''<Summary>
            '''If sent, only instructors who teach lessons with the passed type will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only instructors who teach lessons with the passed type will be returned.", Format:="int64", Name:="TypeId", ParameterType:="query")>
            Public Overridable Property TypeId As Nullable(Of Long)

            '''<Summary>
            '''If sent, only instructors who have an availability record at the passed location will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only instructors who have an availability record at the passed location will be returned.", Format:="int64", Name:="LocationId", ParameterType:="query")>
            Public Overridable Property LocationId As Nullable(Of Long)

            '''<Summary>
            '''If true, basic Availability Info will be included in the response
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="If true, basic Availability Info will be included in the response", Name:="IncludeAvailabilityInfo", ParameterType:="query")>
            Public Overridable Property IncludeAvailabilityInfo As Boolean
        End Class

        <DataContract>
        Public Partial Class GetSchedulingInstructorsResponse
            Inherits BaseResponse
            Public Sub New()
                Instructors = New List(Of InstructorInfo)
            End Sub

            <DataMember>
            Public Overridable Property Instructors As List(Of InstructorInfo)

            <DataContract>
            Public Partial Class InstructorInfo
                <DataMember>
                Public Overridable Property Id As Integer

                <DataMember>
                Public Overridable Property Name As String

                <DataMember>
                Public Overridable Property Email As String

                <DataMember>
                Public Overridable Property Topic As String

                <DataMember>
                Public Overridable Property AvailabilityInfo As InstructorAvailabilityInfo

                Public Partial Class InstructorAvailabilityInfo
                    <DataMember>
                    Public Overridable Property Sunday As Boolean

                    <DataMember>
                    Public Overridable Property Monday As Boolean

                    <DataMember>
                    Public Overridable Property Tuesday As Boolean

                    <DataMember>
                    Public Overridable Property Wednesday As Boolean

                    <DataMember>
                    Public Overridable Property Thursday As Boolean

                    <DataMember>
                    Public Overridable Property Friday As Boolean

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

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

GET /api/GetSchedulingInstructors HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

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