AIM Web Services

<back to all web services

ScheduledExchangesPostRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
POST/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(Name:="FormInput")>
        Public Partial Class FormInput
            '''<Summary>
            '''Field Name of the Input Field
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Field Name of the Input Field", IsRequired:=true, Name:="Key", ParameterType:="query")>
            Public Overridable Property Key As String

            '''<Summary>
            '''Value of the Input Field.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Value of the Input Field.", IsRequired:=true, Name:="Value", ParameterType:="query")>
            Public Overridable Property Value As String

            '''<Summary>
            '''Whether or not the field is encryped with the C2B encryption key.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="Whether or not the field is encryped with the C2B encryption key.", IsRequired:=true, Name:="Encrypted", ParameterType:="query")>
            Public Overridable Property Encrypted As Boolean
        End Class

        '''<Summary>
        '''ScheduledExchangesRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class ScheduledExchangesPostRequest
            Inherits BaseSecureRequest
            Public Sub New()
                FormInputList = New List(Of FormInput)
            End Sub

            <DataMember>
            Public Overridable Property Acct As Integer

            <DataMember>
            Public Overridable Property Sub As Integer

            <DataMember>
            Public Overridable Property ExchangedItemID As Long

            <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 OptionId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property ExchangeNotes As String

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

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

            '''<Summary>
            '''Key/Value pair only. The 'Encrypted' proprety is not used for this API call.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="array", Description:="Key/Value pair only. The 'Encrypted' proprety is not used for this API call.", Name:="FormInputList", ParameterType:="query")>
            Public Overridable Property FormInputList As List(Of FormInput)
        End Class

        <DataContract>
        Public Partial Class ScheduledExchangesPostResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property ExchangeID As Nullable(Of Long)
        End Class
    End Namespace
End Namespace

VB.NET ScheduledExchangesPostRequest 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/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Acct":0,"Sub":0,"ExchangedItemID":0,"NewSku":"String","OptionId":0,"ExchangeNotes":"String","Processed":false,"StatusId":0,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"ExchangeID":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}