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
ContractFulfillmentRequest Parameters:
NameParameterData TypeRequiredDescription
RefbodystringNo
SerialbodystringNo
SerialPkbodylong?No
CashPricebodydecimal?No
NewStatusbodystringNo
NotesbodystringNo
DeliveryDatebodyDateTime?No
DeliveredAccessoriesbodyList<DeliveredAccessory>No
DeletedAccessoryIdsbodyList<long>No
AddedAccessoriesbodyList<Accessory>No
FirstDuebodyDateTime?No
CustomerAcctbodyint?No
UnlockbodyboolNo
MassUpdateItemsbodyList<UpdateContractObj>No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
DeliveredAccessory Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DeliveredformboolNo
Accessory Parameters:
NameParameterData TypeRequiredDescription
DescformstringNo
PriceformdecimalNo
TypeformstringNo
CatNumformintNo
SkuformstringNo
Reportformbool?No
UpdateContractObj Parameters:
NameParameterData TypeRequiredDescription
RefformstringNo
SerialformstringNo
SerialPkformlong?No
CashPriceformdecimal?No
NewStatusformstringNo
NotesformstringNo
DeliveryDateformDateTime?No
DeliveredAccessoriesformList<DeliveredAccessory>No
DeletedAccessoryIdsformList<long>No
AddedAccessoriesformList<Accessory>No
FirstDueformDateTime?No
NewCustomerAcctformint?No
UnlockformboolNo
ContractFulfillmentResponse Parameters:
NameParameterData TypeRequiredDescription
MassUpdateErrorsformList<UpdateContractErrorObj>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
UpdateContractErrorObj Parameters:
NameParameterData TypeRequiredDescription
RefformstringNo
ErrorMessageformstringNo

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