Required role: | API |
All Verbs | /api/Query/Product |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | int | No | |
Group | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
Price | form | decimal | No | |
VAT | form | decimal? | No | |
TotalPrice | form | decimal? | No | |
ProductType | form | int | No | |
Deleted | form | bool | No | |
Demo | form | bool | No | |
UsageCount | form | int? | No | |
StockLevel | form | int? | No | |
ReorderFlag | form | int? | No | |
VisibleOnline | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/Product HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Offset":0,"Total":0,"Results":[{"ProductId":0,"Group":"String","Name":"String","Description":"String","Price":0,"VAT":0,"TotalPrice":0,"ProductType":0,"Deleted":false,"Demo":false,"UsageCount":0,"StockLevel":0,"ReorderFlag":0,"VisibleOnline":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}