Northwind Web Services

<back to all web services

QueryOrders

The following routes are available for this service:
All Verbs/query/orders
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Order Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformstringNo
EmployeeIdformintNo
OrderDateformDateTime?No
RequiredDateformDateTime?No
ShippedDateformDateTime?No
ShipViaformint?No
FreightformdecimalNo
ShipNameformstringNo
ShipAddressformstringNo
ShipCityformstringNo
ShipRegionformstringNo
ShipPostalCodeformstringNo
ShipCountryformstringNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			CustomerId: String,
			EmployeeId: 0,
			OrderDate: 0001-01-01,
			RequiredDate: 0001-01-01,
			ShippedDate: 0001-01-01,
			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
		}
	}
}