AIM Web Services

<back to all web services

CategoryListingRequest

CategoryListing
Requires active-e Inventory Service.

The following routes are available for this service:
GET/api/CategoryListing
"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 SubCategoryAttributeInfo {
    /** @param {{AttributeName?:string,Priority?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttributeName;
    /** @type {number} */
    Priority;
}
export class SubCategoryInfo {
    /** @param {{SubNumber?:number,Description?:string,Active?:boolean,Price?:number,SkuAttributes?:SubCategoryAttributeInfo[],SerialAttributes?:SubCategoryAttributeInfo[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SubNumber;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    Active;
    /** @type {number} */
    Price;
    /** @type {SubCategoryAttributeInfo[]} */
    SkuAttributes;
    /** @type {SubCategoryAttributeInfo[]} */
    SerialAttributes;
}
export class CategoryInfo {
    /** @param {{CategoryNumber?:number,CategoryType?:string,Description?:string,Active?:boolean,SubCategoryListing?:SubCategoryInfo[],PaymentCategoryType?:string,AllowedOnMobile?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CategoryNumber;
    /** @type {string} */
    CategoryType;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    Active;
    /** @type {SubCategoryInfo[]} */
    SubCategoryListing;
    /** @type {string} */
    PaymentCategoryType;
    /** @type {?boolean} */
    AllowedOnMobile;
}
export class CategoryListingResponse extends BaseResponse {
    /** @param {{CategoryListing?:CategoryInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {CategoryInfo[]} */
    CategoryListing;
}
export class CategoryListingRequest extends BaseSecureRequest {
    /** @param {{IncludeInactive?:boolean,CategoryNumber?:number,IncludeInventory?:boolean,IncludeNonInventory?:boolean,IncludeReturn?:boolean,IncludePayment?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?boolean}
     * @description If true, Inactive Categories and Subcategories will be returned. Defaults to false. */
    IncludeInactive;
    /**
     * @type {?number}
     * @description Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored. */
    CategoryNumber;
    /**
     * @type {?boolean}
     * @description If true, Inventory Categories will be returned. Defaults to true. */
    IncludeInventory;
    /**
     * @type {?boolean}
     * @description If true, Non-Inventory Categories will be returned. Defaults to false. */
    IncludeNonInventory;
    /**
     * @type {?boolean}
     * @description If true, Return Payment Categories will be returned. Defaults to false. */
    IncludeReturn;
    /**
     * @type {?boolean}
     * @description If true, Payment Categories will be returned. Defaults to false. */
    IncludePayment;
}

JavaScript CategoryListingRequest DTOs

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

HTTP + XML

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

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

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

<CategoryListingResponse 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>
  <CategoryListing>
    <CategoryInfo>
      <Active>false</Active>
      <AllowedOnMobile>false</AllowedOnMobile>
      <CategoryNumber>0</CategoryNumber>
      <CategoryType>String</CategoryType>
      <Description>String</Description>
      <PaymentCategoryType>String</PaymentCategoryType>
      <SubCategoryListing>
        <SubCategoryInfo>
          <Active>false</Active>
          <Description>String</Description>
          <Price>0</Price>
          <SerialAttributes>
            <SubCategoryAttributeInfo>
              <AttributeName>String</AttributeName>
              <Priority>0</Priority>
            </SubCategoryAttributeInfo>
          </SerialAttributes>
          <SkuAttributes>
            <SubCategoryAttributeInfo>
              <AttributeName>String</AttributeName>
              <Priority>0</Priority>
            </SubCategoryAttributeInfo>
          </SkuAttributes>
          <SubNumber>0</SubNumber>
        </SubCategoryInfo>
      </SubCategoryListing>
    </CategoryInfo>
  </CategoryListing>
</CategoryListingResponse>