| All Verbs | /orders | ||
|---|---|---|---|
| All Verbs | /orders/page/{Page} | ||
| All Verbs | /customers/{CustomerId}/orders |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | |
| CustomerId | path | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<CustomerOrder> | Yes | |
| ResponseStatus | form | ResponseStatus | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Order | form | Order | Yes | |
| OrderDetails | form | List<OrderDetail> | Yes |
| 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 |
|---|---|---|---|---|
| OrderId | form | int | No | |
| ProductId | form | int | No | |
| UnitPrice | form | decimal | No | |
| Quantity | form | short | No | |
| Discount | form | double | No |
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 /orders HTTP/1.1
Host: northwind.netcore.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
page: 0,
customerId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
results:
[
{
order:
{
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
},
orderDetails:
[
{
orderId: 0,
productId: 0,
unitPrice: 0,
quantity: 0,
discount: 0
}
]
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}