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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UpdateContractErrorObj() = 
        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val ErrorMessage:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ContractFulfillmentResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val MassUpdateErrors:ResizeArray<UpdateContractErrorObj> = new ResizeArray<UpdateContractErrorObj>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type DeliveredAccessory() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember>]
        member val Delivered:Boolean = new Boolean() with get,set

    [<DataContract(Name="Accessory")>]
    [<AllowNullLiteral>]
    type Accessory() = 
        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Type:String = null with get,set

        [<DataMember>]
        member val CatNum:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val Report:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UpdateContractObj() = 
        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val SerialPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val CashPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val NewStatus:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val DeliveryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DeliveredAccessories:ResizeArray<DeliveredAccessory> = new ResizeArray<DeliveredAccessory>() with get,set

        [<DataMember>]
        member val DeletedAccessoryIds:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set

        [<DataMember>]
        member val AddedAccessories:ResizeArray<Accessory> = new ResizeArray<Accessory>() with get,set

        [<DataMember>]
        member val FirstDue:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val NewCustomerAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Unlock:Boolean = new Boolean() with get,set

    ///<summary>
    ///ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ContractFulfillmentRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val SerialPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val CashPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val NewStatus:String = null with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        [<DataMember>]
        member val DeliveryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DeliveredAccessories:ResizeArray<DeliveredAccessory> = new ResizeArray<DeliveredAccessory>() with get,set

        [<DataMember>]
        member val DeletedAccessoryIds:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set

        [<DataMember>]
        member val AddedAccessories:ResizeArray<Accessory> = new ResizeArray<Accessory>() with get,set

        [<DataMember>]
        member val FirstDue:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val CustomerAcct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Unlock:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val MassUpdateItems:ResizeArray<UpdateContractObj> = new ResizeArray<UpdateContractObj>() with get,set

F# 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>