| GET | /customers | ||
|---|---|---|---|
| GET | /customers/{CustomerId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | 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 |
|---|---|---|---|---|
| CustomerId | form | long | No | |
| DisplayName | form | string | No | |
| FirstName | form | string | Yes | |
| LastName | form | string | Yes | |
| SupportRepId | form | long? | No | |
| Company | form | string | No | |
| Address | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Country | form | string | No | |
| PostalCode | form | string | No | |
| Phone | form | string | No | |
| Fax | form | string | No | |
| form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<Albums> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AlbumId | form | long | No | |
| Title | form | string | Yes | |
| ArtistId | form | long | 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 /customers HTTP/1.1 Host: chinook.netcore.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
customerId: 0,
displayName: String String,
firstName: String,
lastName: String,
supportRepId: 0,
company: String,
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
}
}
}