Chinook

<back to all web services

QueryCustomers

AutoQueryStore
The following routes are available for this service:
GET/customers
GET/customers/{CustomerId}
QueryCustomers Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathlong?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Customers Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformlongNo
FirstNameformstringYes
LastNameformstringYes
CompanyformstringNo
AddressformstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
PhoneformstringNo
FaxformstringNo
EmailformstringYes
SupportRepIdformlong?No
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.

GET /customers HTTP/1.1 
Host: chinook.netcore.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"customerId":0,"firstName":"String","lastName":"String","company":"String","address":"String","city":"String","state":"String","country":"String","postalCode":"String","phone":"String","fax":"String","email":"String","supportRepId":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}