AIM Web Services

<back to all web services

WebCategoriesRequest

WebCategories
Requires active-e Inventory Service

"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /**
     * @type {string}
     * @description The OAuthToken token return by AeServices30 */
    OAuthToken;
    /**
     * @type {string}
     * @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    DeviceId;
    /**
     * @type {string}
     * @description An identifier for your integration */
    AppId;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The Login Token return by the Security API. Required for secured calls. */
    Token;
}
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,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    IncludePossibleAttributes;
    /** @type {boolean} */
    IncludeImage;
}

JavaScript WebCategoriesRequest DTOs

GET /api/WebCategories HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<WebCategoriesResponse 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>
  <WebCategories>
    <WebCategory>
      <Description>String</Description>
      <FullPath>String</FullPath>
      <Id>0</Id>
      <Image>
        <ErrorMessage>String</ErrorMessage>
        <ImageSize>String</ImageSize>
        <ImageStream>String</ImageStream>
        <UriPk>0</UriPk>
        <Url>String</Url>
      </Image>
      <Name>String</Name>
      <ParentId>0</ParentId>
      <PossibleAttributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </PossibleAttributes>
      <SEAltText>String</SEAltText>
      <SEDescription>String</SEDescription>
      <SEKeywords>String</SEKeywords>
      <SETitle>String</SETitle>
      <ShortDescription>String</ShortDescription>
      <Unpublished>false</Unpublished>
    </WebCategory>
  </WebCategories>
</WebCategoriesResponse>