ClubManager.Api

<back to all web services

FindProduct

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Product
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductInstance Parameters:
NameParameterData TypeRequiredDescription
ProductIdformintNo
GroupformstringNo
NameformstringNo
DescriptionformstringNo
PriceformdecimalNo
VATformdecimal?No
TotalPriceformdecimal?No
ProductTypeformintNo
DeletedformboolNo
DemoformboolNo
UsageCountformint?No
StockLevelformint?No
ReorderFlagformint?No
VisibleOnlineformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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.

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"}}}