Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | query | string | No | |
CompanyNameContains | query | string | No | |
CountryIn | query | string[] | 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 |
---|---|---|---|---|
CustomerId | form | string | No | |
CompanyName | form | string | No | |
Address | form | string | No | |
City | form | string | No | |
Region | form | string | No | |
PostalCode | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
Orders | form | List<Order> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrderId | form | int | No | |
CustomerId | form | string | No | |
OrderDate | form | DateTime | No | |
Total | form | double | No |
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 |
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 /jsv/reply/QueryCustomers HTTP/1.1
Host: sharpscript.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customerId: String,
companyNameContains: String,
countryIn:
[
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: [ { customerId: String, companyName: String, address: String, city: String, region: String, postalCode: String, country: String, phone: String, fax: String, orders: [ { orderId: 0, customerId: String, orderDate: 0001-01-01, total: 0 } ] } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }