AIM Web Services

<back to all web services

GetImageRequest

GetImage
Requires active-e Customer Service for Customer Images
Requires active-e Inventory Service for Inventory Images.

The following routes are available for this service:
GET/api/GetImage
"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 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 GetImageResponse extends BaseResponse {
    /** @param {{Images?:ImageInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ImageInfo[]} */
    Images;
}
export class GetImageRequest extends BaseRequest {
    /** @param {{CustomerAcct?:number,InventoryPk?:number,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description If sent, image(s) for this customer will be returned. */
    CustomerAcct;
    /**
     * @type {?number}
     * @description If sent, image(s) for this inventory item will be returned. */
    InventoryPk;
}

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

GET /api/GetImage HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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