Chinook

<back to all web services

QueryEmployees

AutoQueryStore
The following routes are available for this service:
GET/employees
GET/employees/{EmployeeId}
QueryEmployees Parameters:
NameParameterData TypeRequiredDescription
EmployeeIdpathlong?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Employees Parameters:
NameParameterData TypeRequiredDescription
EmployeeIdformlongNo
LastNameformstringYes
FirstNameformstringYes
TitleformstringNo
ReportsToformlong?No
BirthDateformDateTime?No
HireDateformDateTime?No
AddressformstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
PhoneformstringNo
FaxformstringNo
EmailformstringNo
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.

GET /employees HTTP/1.1 
Host: chinook.netcore.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			employeeId: 0,
			lastName: String,
			firstName: String,
			title: String,
			reportsTo: 0,
			birthDate: 0001-01-01,
			hireDate: 0001-01-01,
			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
		}
	}
}