| 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 | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| 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 .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"CategoryListing":[{"CategoryNumber":0,"CategoryType":"String","Description":"String","Active":false,"SubCategoryListing":[{"SubNumber":0,"Description":"String","Active":false,"Price":0,"SkuAttributes":[{"AttributeName":"String","Priority":0}],"SerialAttributes":[{"AttributeName":"String","Priority":0}]}],"PaymentCategoryType":"String","AllowedOnMobile":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}