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 .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>