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 .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","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"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"}}