AIM Web Services

<back to all web services

EditInventoryRequest

EditInventory
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/EditInventory
"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 EditInventoryResponse extends BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class EditInventoryRequest extends BaseSecureRequest {
    /** @param {{SaqPk?:number,SasPk?:number,Description?:string,OurPrice?:number,RetailPrice?:number,PriceA?:number,PriceB?:number,PriceC?:number,MinPrice?:number,ActiveEPrice?:number,Locator?:string,UpdateAllLocations?:boolean,Barcodes?:string[],NewComputerQuantity?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    SaqPk;
    /** @type {?number} */
    SasPk;
    /** @type {string} */
    Description;
    /** @type {?number} */
    OurPrice;
    /** @type {?number} */
    RetailPrice;
    /** @type {?number} */
    PriceA;
    /** @type {?number} */
    PriceB;
    /** @type {?number} */
    PriceC;
    /** @type {?number} */
    MinPrice;
    /** @type {?number} */
    ActiveEPrice;
    /** @type {string} */
    Locator;
    /** @type {boolean} */
    UpdateAllLocations;
    /**
     * @type {string[]}
     * @description List of Barcodes. If barcodes are sent, they will overwrite existing barcodes. */
    Barcodes;
    /** @type {?number} */
    NewComputerQuantity;
}

JavaScript EditInventoryRequest 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/EditInventory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SaqPk":0,"SasPk":0,"Description":"String","OurPrice":0,"RetailPrice":0,"PriceA":0,"PriceB":0,"PriceC":0,"MinPrice":0,"ActiveEPrice":0,"Locator":"String","UpdateAllLocations":false,"Barcodes":["String"],"NewComputerQuantity":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}