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
            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property Type As String

            <DataMember>
            Public Overridable Property CatNum As Integer

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            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

            <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>
        '''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 .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.

POST /api/ContractFulfillment HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContractFulfillmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <AddedAccessories>
    <Accessory>
      <CatNum>0</CatNum>
      <Desc>String</Desc>
      <Price>0</Price>
      <Report>false</Report>
      <Sku>String</Sku>
      <Type>String</Type>
    </Accessory>
  </AddedAccessories>
  <CashPrice>0</CashPrice>
  <CustomerAcct>0</CustomerAcct>
  <DeletedAccessoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </DeletedAccessoryIds>
  <DeliveredAccessories>
    <ContractFulfillmentRequest.DeliveredAccessory>
      <Delivered>false</Delivered>
      <Id>0</Id>
    </ContractFulfillmentRequest.DeliveredAccessory>
  </DeliveredAccessories>
  <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
  <FirstDue>0001-01-01T00:00:00</FirstDue>
  <MassUpdateItems>
    <ContractFulfillmentRequest.UpdateContractObj>
      <AddedAccessories>
        <Accessory>
          <CatNum>0</CatNum>
          <Desc>String</Desc>
          <Price>0</Price>
          <Report>false</Report>
          <Sku>String</Sku>
          <Type>String</Type>
        </Accessory>
      </AddedAccessories>
      <CashPrice>0</CashPrice>
      <DeletedAccessoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>0</d4p1:long>
      </DeletedAccessoryIds>
      <DeliveredAccessories>
        <ContractFulfillmentRequest.DeliveredAccessory>
          <Delivered>false</Delivered>
          <Id>0</Id>
        </ContractFulfillmentRequest.DeliveredAccessory>
      </DeliveredAccessories>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <NewCustomerAcct>0</NewCustomerAcct>
      <NewStatus>String</NewStatus>
      <Notes>String</Notes>
      <Ref>String</Ref>
      <Serial>String</Serial>
      <SerialPk>0</SerialPk>
      <Unlock>false</Unlock>
    </ContractFulfillmentRequest.UpdateContractObj>
  </MassUpdateItems>
  <NewStatus>String</NewStatus>
  <Notes>String</Notes>
  <Ref>String</Ref>
  <Serial>String</Serial>
  <SerialPk>0</SerialPk>
  <Unlock>false</Unlock>
</ContractFulfillmentRequest>

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

<ContractFulfillmentResponse 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>
  <MassUpdateErrors>
    <UpdateContractErrorObj>
      <ErrorMessage>String</ErrorMessage>
      <Ref>String</Ref>
    </UpdateContractErrorObj>
  </MassUpdateErrors>
</ContractFulfillmentResponse>