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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class UpdateContractErrorObj {
    /** @param {{Ref?:string,ErrorMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Ref;
    /** @type {string} */
    ErrorMessage;
}
export class ContractFulfillmentResponse extends BaseResponse {
    /** @param {{MassUpdateErrors?:UpdateContractErrorObj[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UpdateContractErrorObj[]} */
    MassUpdateErrors;
}
export class DeliveredAccessory {
    /** @param {{Id?:number,Delivered?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {boolean} */
    Delivered;
}
export class Accessory {
    /** @param {{Desc?:string,Price?:number,Type?:string,CatNum?:number,Sku?:string,Report?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Desc;
    /** @type {number} */
    Price;
    /** @type {string} */
    Type;
    /** @type {number} */
    CatNum;
    /** @type {string} */
    Sku;
    /** @type {?boolean} */
    Report;
}
export class UpdateContractObj {
    /** @param {{Ref?:string,Serial?:string,SerialPk?:number,CashPrice?:number,NewStatus?:string,Notes?:string,DeliveryDate?:string,DeliveredAccessories?:DeliveredAccessory[],DeletedAccessoryIds?:number[],AddedAccessories?:Accessory[],FirstDue?:string,NewCustomerAcct?:number,Unlock?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Ref;
    /** @type {string} */
    Serial;
    /** @type {?number} */
    SerialPk;
    /** @type {?number} */
    CashPrice;
    /** @type {string} */
    NewStatus;
    /** @type {string} */
    Notes;
    /** @type {?string} */
    DeliveryDate;
    /** @type {DeliveredAccessory[]} */
    DeliveredAccessories;
    /** @type {number[]} */
    DeletedAccessoryIds;
    /** @type {Accessory[]} */
    AddedAccessories;
    /** @type {?string} */
    FirstDue;
    /** @type {?number} */
    NewCustomerAcct;
    /** @type {boolean} */
    Unlock;
}
export class ContractFulfillmentRequest extends BaseSecureRequest {
    /** @param {{Ref?:string,Serial?:string,SerialPk?:number,CashPrice?:number,NewStatus?:string,Notes?:string,DeliveryDate?:string,DeliveredAccessories?:DeliveredAccessory[],DeletedAccessoryIds?:number[],AddedAccessories?:Accessory[],FirstDue?:string,CustomerAcct?:number,Unlock?:boolean,MassUpdateItems?:UpdateContractObj[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Ref;
    /** @type {string} */
    Serial;
    /** @type {?number} */
    SerialPk;
    /** @type {?number} */
    CashPrice;
    /** @type {string} */
    NewStatus;
    /** @type {string} */
    Notes;
    /** @type {?string} */
    DeliveryDate;
    /** @type {DeliveredAccessory[]} */
    DeliveredAccessories;
    /** @type {number[]} */
    DeletedAccessoryIds;
    /** @type {Accessory[]} */
    AddedAccessories;
    /** @type {?string} */
    FirstDue;
    /** @type {?number} */
    CustomerAcct;
    /** @type {boolean} */
    Unlock;
    /** @type {UpdateContractObj[]} */
    MassUpdateItems;
}

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