| GET | /employees | ||
|---|---|---|---|
| GET | /employees/{EmployeeId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmployeeId | 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 |
|---|---|---|---|---|
| EmployeeId | form | long | No | |
| LastName | form | string | Yes | |
| FirstName | form | string | Yes | |
| Title | form | string | Yes | |
| ReportsTo | form | long? | No | |
| BirthDate | form | DateTime? | No | |
| HireDate | form | DateTime? | No | |
| Address | form | string | Yes | |
| City | form | string | Yes | |
| State | form | string | Yes | |
| Country | form | string | Yes | |
| PostalCode | form | string | Yes | |
| Phone | form | string | Yes | |
| Fax | form | string | Yes | |
| form | string | Yes |
| 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 /employees 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:
[
{
employeeId: 0,
lastName: String,
firstName: String,
title: String,
reportsTo: 0,
birthDate: 0001-01-01,
hireDate: 0001-01-01,
address: String,
city: String,
state: String,
country: String,
postalCode: String,
phone: String,
fax: String,
email: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}