Northwind Web Services

<back to all web services

QueryOrders

AutoQuery
The following routes are available for this service:
All Verbs/query/orders
QueryOrders Parameters:
NameParameterData TypeRequiredDescription
Freightquerydecimal?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformstringYes
EmployeeIdformintNo
OrderDateformDateTime?No
RequiredDateformDateTime?No
ShippedDateformDateTime?No
ShipViaformint?No
FreightformdecimalNo
ShipNameformstringYes
ShipAddressformstringYes
ShipCityformstringYes
ShipRegionformstringYes
ShipPostalCodeformstringYes
ShipCountryformstringYes
QueryResponse<Customer> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Customer>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
CompanyNameformstringYes
ContactNameformstringYes
ContactTitleformstringYes
AddressformstringYes
CityformstringYes
RegionformstringYes
PostalCodeformstringYes
CountryformstringYes
PhoneformstringYes
FaxformstringYes

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.

POST /query/orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"freight":0,"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"customerId":"String","employeeId":0,"orderDate":"\/Date(-62135596800000-0000)\/","requiredDate":"\/Date(-62135596800000-0000)\/","shippedDate":"\/Date(-62135596800000-0000)\/","shipVia":0,"freight":0,"shipName":"String","shipAddress":"String","shipCity":"String","shipRegion":"String","shipPostalCode":"String","shipCountry":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}