AIM Web Services

<back to all web services

ScheduledExchangesGetRequest

ScheduledExchanges
Requires active-e Contracts Service.

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

        <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

        <DataContract>
        Public Partial Class ScheduledExchangesGetInfo
            <DataMember>
            Public Overridable Property ExchangeID As Long

            <DataMember>
            Public Overridable Property Acct As Integer

            <DataMember>
            Public Overridable Property Sub As Integer

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Address As String

            <DataMember>
            Public Overridable Property Address2 As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property Student As String

            <DataMember>
            Public Overridable Property School As String

            <DataMember>
            Public Overridable Property District As String

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property Employee As String

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

            <DataMember>
            Public Overridable Property StockNumber As String

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property ReturnOption As String

            <DataMember>
            Public Overridable Property ScheduledReturnedRef As String

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property History As String

            <DataMember>
            Public Overridable Property ExchangeRef As Nullable(Of Long)

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

            <DataMember>
            Public Overridable Property ExchangedItem As String

            <DataMember>
            Public Overridable Property PostingDate As Date

            <DataMember>
            Public Overridable Property ScheduledDate As Date

            <DataMember>
            Public Overridable Property NewSku As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Source As String

            <DataMember>
            Public Overridable Property [Option] As String

            <DataMember>
            Public Overridable Property Processed As Boolean

            <DataMember>
            Public Overridable Property MobileExchangedStatus As Boolean
        End Class

        '''<Summary>
        '''ScheduledExchangesRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class ScheduledExchangesGetRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property ScheduledDateFrom As Nullable(Of Date)

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

            <DataMember>
            Public Overridable Property DistrictId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property SchoolId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property LocationId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property StatusId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property OptionId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property IncludeProcessed As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property LanId As String
        End Class

        <DataContract>
        Public Partial Class ScheduledExchangesGetResponse
            Inherits BaseResponse
            Public Sub New()
                ScheduledExchanges = New List(Of ScheduledExchangesGetInfo)
            End Sub

            <DataMember>
            Public Overridable Property ScheduledExchanges As List(Of ScheduledExchangesGetInfo)
        End Class
    End Namespace
End Namespace

VB.NET ScheduledExchangesGetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ScheduledExchanges":[{"ExchangeID":0,"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","History":"String","ExchangeRef":0,"AutoPayHoldDate":"0001-01-01T00:00:00.0000000","ExchangedItem":"String","NewSku":"String","Notes":"String","Source":"String","Option":"String","Processed":false,"MobileExchangedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}