AIM Web Services

<back to all web services

ContractFulfillmentRequest

ContractFulfillment
Requires active-e Contracts Service.
This API call used to be named C2BSetContractSerial.

The following routes are available for this service:
POST/api/ContractFulfillment
POST/api/C2BSetContractSerial
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(Name:="Accessory")>
        Public Partial Class Accessory
            '''<Summary>
            '''The description to be used for the Accessory
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The description to be used for the Accessory", IsRequired:=true, Name:="Desc", ParameterType:="body")>
            Public Overridable Property Desc As String

            '''<Summary>
            '''The price to be used for the Accessory
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="The price to be used for the Accessory", Name:="Price", ParameterType:="body")>
            Public Overridable Property Price As Decimal

            '''<Summary>
            '''The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance", Name:="Type", ParameterType:="body")>
            Public Overridable Property Type As String

            '''<Summary>
            '''The category # in AIM to be linked to this accessory.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="The category # in AIM to be linked to this accessory.", Name:="CatNum", ParameterType:="body")>
            Public Overridable Property CatNum As Integer

            '''<Summary>
            '''A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.", Name:="Sku", ParameterType:="body")>
            Public Overridable Property Sku As String

            '''<Summary>
            '''Internal Use Only
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="bool", Description:="Internal Use Only", Name:="Report", ParameterType:="body")>
            Public Overridable Property Report As Nullable(Of Boolean)
        End Class

        <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

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        '''<Summary>
        '''ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
        '''</Summary>
        <DataContract>
        Public Partial Class ContractFulfillmentRequest
            Inherits BaseSecureRequest
            Public Sub New()
                DeliveredAccessories = New List(Of DeliveredAccessory)
                DeletedAccessoryIds = New List(Of Long)
                AddedAccessories = New List(Of Accessory)
                MassUpdateItems = New List(Of UpdateContractObj)
            End Sub

            <DataMember>
            Public Overridable Property Ref As String

            <DataMember>
            Public Overridable Property Serial As String

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

            <DataMember>
            Public Overridable Property CashPrice As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property NewStatus As String

            <DataMember>
            Public Overridable Property Notes As String

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

            <DataMember>
            Public Overridable Property DeliveredAccessories As List(Of DeliveredAccessory)

            <DataMember>
            Public Overridable Property DeletedAccessoryIds As List(Of Long)

            <DataMember>
            Public Overridable Property AddedAccessories As List(Of Accessory)

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

            <DataMember>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property Unlock As Boolean

            <DataMember>
            Public Overridable Property MassUpdateItems As List(Of UpdateContractObj)

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

                <DataMember>
                Public Overridable Property Delivered As Boolean
            End Class

            <DataContract>
            Public Partial Class UpdateContractObj
                Public Sub New()
                    DeliveredAccessories = New List(Of DeliveredAccessory)
                    DeletedAccessoryIds = New List(Of Long)
                    AddedAccessories = New List(Of Accessory)
                End Sub

                <DataMember>
                Public Overridable Property Ref As String

                <DataMember>
                Public Overridable Property Serial As String

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

                <DataMember>
                Public Overridable Property CashPrice As Nullable(Of Decimal)

                <DataMember>
                Public Overridable Property NewStatus As String

                <DataMember>
                Public Overridable Property Notes As String

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

                <DataMember>
                Public Overridable Property DeliveredAccessories As List(Of DeliveredAccessory)

                <DataMember>
                Public Overridable Property DeletedAccessoryIds As List(Of Long)

                <DataMember>
                Public Overridable Property AddedAccessories As List(Of Accessory)

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

                <DataMember>
                Public Overridable Property NewCustomerAcct As Nullable(Of Integer)

                <DataMember>
                Public Overridable Property Unlock As Boolean
            End Class
        End Class

        <DataContract>
        Public Partial Class ContractFulfillmentResponse
            Inherits BaseResponse
            Public Sub New()
                MassUpdateErrors = New List(Of UpdateContractErrorObj)
            End Sub

            <DataMember>
            Public Overridable Property MassUpdateErrors As List(Of UpdateContractErrorObj)
        End Class

        <DataContract>
        Public Partial Class UpdateContractErrorObj
            <DataMember>
            Public Overridable Property Ref As String

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

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

{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","CustomerAcct":0,"Unlock":false,"MassUpdateItems":[{"Ref":"String","Serial":"String","SerialPk":0,"CashPrice":0,"NewStatus":"String","Notes":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveredAccessories":[{"Id":0,"Delivered":false}],"DeletedAccessoryIds":[0],"AddedAccessories":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FirstDue":"0001-01-01T00:00:00.0000000","NewCustomerAcct":0,"Unlock":false}],"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

{"MassUpdateErrors":[{"Ref":"String","ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}