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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
*/
@DataContract
open class ContractFulfillmentRequest : BaseSecureRequest()
{
    @DataMember
    var Ref:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var SerialPk:Long? = null

    @DataMember
    var CashPrice:BigDecimal? = null

    @DataMember
    var NewStatus:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var DeliveryDate:Date? = null

    @DataMember
    var DeliveredAccessories:ArrayList<DeliveredAccessory> = ArrayList<DeliveredAccessory>()

    @DataMember
    var DeletedAccessoryIds:ArrayList<Long> = ArrayList<Long>()

    @DataMember
    var AddedAccessories:ArrayList<Accessory> = ArrayList<Accessory>()

    @DataMember
    var FirstDue:Date? = null

    @DataMember
    var CustomerAcct:Int? = null

    @DataMember
    var Unlock:Boolean? = null

    @DataMember
    var MassUpdateItems:ArrayList<UpdateContractObj> = ArrayList<UpdateContractObj>()
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class DeliveredAccessory
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Delivered:Boolean? = null
}

@DataContract(Name="Accessory")
open class Accessory
{
    /**
    * The description to be used for the Accessory
    */
    @DataMember
    @ApiMember(DataType="string", Description="The description to be used for the Accessory", IsRequired=true, Name="Desc", ParameterType="body")
    var Desc:String? = null

    /**
    * The price to be used for the Accessory
    */
    @DataMember
    @ApiMember(DataType="decimal", Description="The price to be used for the Accessory", Name="Price", ParameterType="body")
    var Price:BigDecimal? = null

    /**
    * The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance
    */
    @DataMember
    @ApiMember(DataType="string", Description="The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance", Name="Type", ParameterType="body")
    var Type:String? = null

    /**
    * The category # in AIM to be linked to this accessory.
    */
    @DataMember
    @ApiMember(DataType="int", Description="The category # in AIM to be linked to this accessory.", Name="CatNum", ParameterType="body")
    var CatNum:Int? = null

    /**
    * A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.
    */
    @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")
    var Sku:String? = null

    /**
    * Internal Use Only
    */
    @DataMember
    @ApiMember(DataType="bool", Description="Internal Use Only", Name="Report", ParameterType="body")
    var Report:Boolean? = null
}

@DataContract
open class UpdateContractObj
{
    @DataMember
    var Ref:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var SerialPk:Long? = null

    @DataMember
    var CashPrice:BigDecimal? = null

    @DataMember
    var NewStatus:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var DeliveryDate:Date? = null

    @DataMember
    var DeliveredAccessories:ArrayList<DeliveredAccessory> = ArrayList<DeliveredAccessory>()

    @DataMember
    var DeletedAccessoryIds:ArrayList<Long> = ArrayList<Long>()

    @DataMember
    var AddedAccessories:ArrayList<Accessory> = ArrayList<Accessory>()

    @DataMember
    var FirstDue:Date? = null

    @DataMember
    var NewCustomerAcct:Int? = null

    @DataMember
    var Unlock:Boolean? = null
}

@DataContract
open class ContractFulfillmentResponse : BaseResponse()
{
    @DataMember
    var MassUpdateErrors:ArrayList<UpdateContractErrorObj> = ArrayList<UpdateContractErrorObj>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class UpdateContractErrorObj
{
    @DataMember
    var Ref:String? = null

    @DataMember
    var ErrorMessage:String? = null
}

Kotlin 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"}}