| All Verbs | /query/orders |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Freight | query | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CustomerId | form | string | Yes | |
| EmployeeId | form | int | No | |
| OrderDate | form | DateTime? | No | |
| RequiredDate | form | DateTime? | No | |
| ShippedDate | form | DateTime? | No | |
| ShipVia | form | int? | No | |
| Freight | form | decimal | No | |
| ShipName | form | string | Yes | |
| ShipAddress | form | string | Yes | |
| ShipCity | form | string | Yes | |
| ShipRegion | form | string | Yes | |
| ShipPostalCode | form | string | Yes | |
| ShipCountry | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<Customer> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | |
| CompanyName | form | string | Yes | |
| ContactName | form | string | Yes | |
| ContactTitle | form | string | Yes | |
| Address | form | string | Yes | |
| City | form | string | Yes | |
| Region | form | string | Yes | |
| PostalCode | form | string | Yes | |
| Country | form | string | Yes | |
| Phone | form | string | Yes | |
| Fax | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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.netcore.io
Accept: text/jsv
Content-Type: text/jsv
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: 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
}
}
}