Chinook

<back to all web services

QueryCustomers

Store
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
DisplayNameformstringNo
FirstNameformstringYes
LastNameformstringYes
SupportRepIdformlong?No
CompanyformstringNo
AddressformstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
PhoneformstringNo
FaxformstringNo
EmailformstringYes
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Albums>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Albums Parameters:
NameParameterData TypeRequiredDescription
AlbumIdformlongNo
TitleformstringYes
ArtistIdformlongNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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