Northwind Web Services

<back to all web services

QueryCustomers

The following routes are available for this service:
All Verbs/query/customers
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CompanyNameformstringNo
ContactNameformstringNo
ContactTitleformstringNo
AddressformstringNo
CityformstringNo
RegionformstringNo
PostalCodeformstringNo
CountryformstringNo
PhoneformstringNo
FaxformstringNo
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 .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /query/customers HTTP/1.1 
Host: northwind.servicestack.net 
Accept: text/x-vcard
Content-Type: text/x-vcard
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/x-vcard
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":"String","CompanyName":"String","ContactName":"String","ContactTitle":"String","Address":"String","City":"String","Region":"String","PostalCode":"String","Country":"String","Phone":"String","Fax":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}