AIM Web Services

<back to all web services

C2BAccessoryListingRequest

C2BAccessoryListing
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BAccessoryListing
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 C2BDistrictGeneric
            <DataMember>
            Public Overridable Property DistrictName As String

            <DataMember>
            Public Overridable Property SchoolCount As Integer

            <DataMember>
            Public Overridable Property TeacherCount As Integer

            <DataMember>
            Public Overridable Property Topic As String

            <DataMember>
            Public Overridable Property Id As Long
        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>
        '''C2BAccessoryListingRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class C2BAccessoryListingRequest
            Inherits BaseSecureRequest
            '''<Summary>
            '''Defaults to True
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Defaults to True", Name:="IncludeAccessories", ParameterType:="query")>
            Public Overridable Property IncludeAccessories As Nullable(Of Boolean)

            '''<Summary>
            '''Defaults to False
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Defaults to False", Name:="IncludeDeliveryOptions", ParameterType:="query")>
            Public Overridable Property IncludeDeliveryOptions As Nullable(Of Boolean)

            '''<Summary>
            '''Defaults to False
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Defaults to False", Name:="IncludeMaintenanceOptions", ParameterType:="query")>
            Public Overridable Property IncludeMaintenanceOptions As Nullable(Of Boolean)

            '''<Summary>
            '''If passed, only accessories for the given instrument are returned
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="If passed, only accessories for the given instrument are returned", Name:="InstrumentId", ParameterType:="query")>
            Public Overridable Property InstrumentId As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class C2BGetDistrictInfoResponse
            Inherits BaseResponse
            Public Sub New()
                Districts = New List(Of C2BDistrictGeneric)
            End Sub

            <DataMember>
            Public Overridable Property Districts As List(Of C2BDistrictGeneric)

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

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

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

<C2BGetDistrictInfoResponse 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>
  <Districts xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:C2BDistrictGeneric i:nil="true" />
  </Districts>
  <TeacherTableExists>false</TeacherTableExists>
</C2BGetDistrictInfoResponse>