GET | /categories | Returns a list of all available Categories |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Categories | form | List<CategoryStub> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CategoryId | form | long | No | |
Name | form | string | No | |
ParentCategoryId | form | long? | No | |
HasChildren | form | bool | No | |
ProductsUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /categories HTTP/1.1 Host: avb-pos.avbportal.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, categories: [ { categoryId: 0, name: String, parentCategoryId: 0, hasChildren: False, productsUrl: String } ] }