Northwind Web Services

<back to all web services

QueryCustomers

AutoQuery
The following routes are available for this service:
All Verbs/query/customers
QueryCustomers Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<string>Yes
CountryStartsWithquerystringYes
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
CompanyNameformstringYes
ContactNameformstringYes
ContactTitleformstringYes
AddressformstringYes
CityformstringYes
RegionformstringYes
PostalCodeformstringYes
CountryformstringYes
PhoneformstringYes
FaxformstringYes
QueryResponse<Customer> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Customer>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/customers HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ids: 
	[
		String
	],
	countryStartsWith: String,
	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: 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
		}
	}
}