| GET | /api/WebCategories |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludePossibleAttributes | query | bool | No | |
| IncludeImage | query | bool | No |
| 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 |
|---|---|---|---|---|
| WebCategories | form | List<WebCategory> | 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 |
|---|---|---|---|---|
| Id | form | long | No | |
| ParentId | form | long? | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| FullPath | form | string | No | |
| ShortDescription | form | string | No | |
| SETitle | form | string | No | |
| SEKeywords | form | string | No | |
| SEDescription | form | string | No | |
| SEAltText | form | string | No | |
| PossibleAttributes | form | List<string> | No | |
| Image | form | ImageInfo | No | |
| Unpublished | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Url | form | string | No | |
| ImageStream | form | string | No | |
| ImageSize | form | string | No | |
| ErrorMessage | form | string | No | |
| UriPk | form | long? | 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/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"}}