| All Verbs | /cached/customers/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Customer | form | Customer | Yes | |
| Orders | form | List<CustomerOrder> | Yes | |
| ResponseStatus | form | ResponseStatus | Yes |
| 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 |
| 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 /cached/customers/{Id} HTTP/1.1
Host: northwind.netcore.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
customer:
{
id: String,
companyName: String,
contactName: String,
contactTitle: String,
address: String,
city: String,
region: String,
postalCode: String,
country: String,
phone: String,
fax: String
},
orders:
[
{
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
}
}
}