AIM Web Services

<back to all web services

WebCategoriesRequest

WebCategories
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/WebCategories
"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 WebCategory {
    /** @param {{Id?:number,ParentId?:number,Name?:string,Description?:string,FullPath?:string,ShortDescription?:string,SETitle?:string,SEKeywords?:string,SEDescription?:string,SEAltText?:string,PossibleAttributes?:string[],Image?:ImageInfo,Unpublished?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {?number} */
    ParentId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    FullPath;
    /** @type {string} */
    ShortDescription;
    /** @type {string} */
    SETitle;
    /** @type {string} */
    SEKeywords;
    /** @type {string} */
    SEDescription;
    /** @type {string} */
    SEAltText;
    /** @type {string[]} */
    PossibleAttributes;
    /** @type {ImageInfo} */
    Image;
    /** @type {boolean} */
    Unpublished;
}
export class WebCategoriesResponse extends BaseResponse {
    /** @param {{WebCategories?:WebCategory[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {WebCategory[]} */
    WebCategories;
}
export class WebCategoriesRequest extends BaseSecureRequest {
    /** @param {{IncludePossibleAttributes?:boolean,IncludeImage?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    IncludePossibleAttributes;
    /** @type {boolean} */
    IncludeImage;
}

JavaScript WebCategoriesRequest 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/WebCategories HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"WebCategories":[{"Id":0,"ParentId":0,"Name":"String","Description":"String","FullPath":"String","ShortDescription":"String","SETitle":"String","SEKeywords":"String","SEDescription":"String","SEAltText":"String","PossibleAttributes":["String"],"Image":{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0},"Unpublished":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}