AVB LINQ Public API

<back to all web services

CategoryRequest

Categories
The following routes are available for this service:
GET/categoriesReturns a list of all available Categories
CategoryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CategoriesformList<CategoryStub>No
CategoryStub Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformlongNo
NameformstringNo
ParentCategoryIdformlong?No
HasChildrenformboolNo
ProductsUrlformstringNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}