AIM Web Services

<back to all web services

GetSchedulingGroupingsRequest

GetSchedulingGroupings
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingGroupings
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>
        '''GetSchedulingGroupingsRequires active-e Lesson Scheduling Service
        '''</Summary>
        <DataContract>
        Public Partial Class GetSchedulingGroupingsRequest
            Inherits BaseRequest
            '''<Summary>
            '''Grouping ID to look up. If sent, all other parameters will be ignored.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Grouping ID to look up. If sent, all other parameters will be ignored.", Format:="int64", Name:="GroupingId", ParameterType:="query")>
            Public Overridable Property GroupingId As Nullable(Of Long)

            '''<Summary>
            '''If sent, only groupings with at least one lesson type taught by the sent instructor will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only groupings with at least one lesson type 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, only groupings taught at the sent location will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, only groupings taught at the sent location will be returned.", Format:="int64", Name:="LocationId", ParameterType:="query")>
            Public Overridable Property LocationId As Nullable(Of Long)

            '''<Summary>
            '''If sent, should be Private or Group. If Private, only groupings containing Private Lesson Types will be returned. If Group, only groupings containing Group Lesson Types will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, should be Private or Group. If Private, only groupings containing Private Lesson Types will be returned. If Group, only groupings containing Group Lesson Types will be returned.", Format:="int64", Name:="MembershipType", ParameterType:="query")>
            Public Overridable Property MembershipType As String
        End Class

        <DataContract>
        Public Partial Class GetSchedulingGroupingsResponse
            Inherits BaseResponse
            Public Sub New()
                Groupings = New List(Of GroupingInfo)
            End Sub

            <DataMember>
            Public Overridable Property Groupings As List(Of GroupingInfo)

            <DataContract>
            Public Partial Class GroupingInfo
                <DataMember>
                Public Overridable Property Id As Long

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

VB.NET GetSchedulingGroupingsRequest 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/GetSchedulingGroupings HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingGroupingsResponse 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>
  <Groupings>
    <GetSchedulingGroupingsResponse.GroupingInfo>
      <Desc>String</Desc>
      <Id>0</Id>
    </GetSchedulingGroupingsResponse.GroupingInfo>
  </Groupings>
</GetSchedulingGroupingsResponse>