| GET | /invoices | ||
|---|---|---|---|
| GET | /invoices/{InvoiceId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceId | path | long? | 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 |
|---|---|---|---|---|
| InvoiceId | form | long | No | |
| CustomerId | form | long | No | |
| InvoiceDate | form | DateTime | No | |
| BillingAddress | form | string | Yes | |
| BillingCity | form | string | Yes | |
| BillingState | form | string | Yes | |
| BillingCountry | form | string | Yes | |
| BillingPostalCode | form | string | Yes | |
| Total | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<Todo> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Text | form | string | Yes | |
| IsFinished | form | bool | 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.
GET /invoices HTTP/1.1 Host: blazor-gallery.servicestack.net Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
invoiceId: 0,
customerId: 0,
invoiceDate: 0001-01-01,
billingAddress: String,
billingCity: String,
billingState: String,
billingCountry: String,
billingPostalCode: String,
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
}
}
}