AIM Web Services

<back to all web services

InventoryImageRequest

InventoryImage
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/InventoryImage
"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 ImageInfo {
    /** @param {{Url?:string,ImageStream?:string,ImageSize?:string,ErrorMessage?:string,UriPk?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Url;
    /** @type {string} */
    ImageStream;
    /** @type {string} */
    ImageSize;
    /** @type {string} */
    ErrorMessage;
    /** @type {?number} */
    UriPk;
}
export class InventoryImageResponse extends BaseResponse {
    /** @param {{Images?:ImageInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ImageInfo[]} */
    Images;
}
export class NewImageInfo {
    /** @param {{FileName?:string,Description?:string,Base64Image?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FileName;
    /** @type {string} */
    Description;
    /** @type {string} */
    Base64Image;
}
export class InventoryImageRequest extends BaseSecureRequest {
    /** @param {{Item?:string,ItemPk?:number,ItemType?:string,NewImages?:NewImageInfo[],UriImagePksToDelete?:number[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Item;
    /** @type {?number} */
    ItemPk;
    /**
     * @type {string}
     * @description Model, SKU, or Serial. Defaults to Model. */
    ItemType;
    /**
     * @type {NewImageInfo[]}
     * @description Images (in Base64) to add to the Item. Only for POST. */
    NewImages;
    /**
     * @type {number[]}
     * @description URI Image PKs to remove from the Item. Only for POST. */
    UriImagePksToDelete;
}

JavaScript InventoryImageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/InventoryImage HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Item":"String","ItemPk":0,"ItemType":"String","NewImages":[{"FileName":"String","Description":"String","Base64Image":"String"}],"UriImagePksToDelete":[0],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}