| GET | /api/CategoryListing |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeInactive | query | boolean | No | If true, Inactive Categories and Subcategories will be returned. Defaults to false. |
| CategoryNumber | query | integer | No | Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored. |
| IncludeInventory | query | boolean | No | If true, Inventory Categories will be returned. Defaults to true. |
| IncludeNonInventory | query | boolean | No | If true, Non-Inventory Categories will be returned. Defaults to false. |
| IncludeReturn | query | boolean | No | If true, Return Payment Categories will be returned. Defaults to false. |
| IncludePayment | query | boolean | No | If true, Payment Categories will be returned. Defaults to false. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CategoryListing | form | List<CategoryInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CategoryNumber | form | int | No | |
| CategoryType | form | string | No | |
| Description | form | string | No | |
| Active | form | bool | No | |
| SubCategoryListing | form | List<SubCategoryInfo> | No | |
| PaymentCategoryType | form | string | No | |
| AllowedOnMobile | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubNumber | form | int | No | |
| Description | form | string | No | |
| Active | form | bool | No | |
| Price | form | decimal | No | |
| SkuAttributes | form | List<SubCategoryAttributeInfo> | No | |
| SerialAttributes | form | List<SubCategoryAttributeInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttributeName | form | string | No | |
| Priority | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>