| Required role: | API |
| All Verbs | /api/Query/SalesLossReasons |
|---|
| 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 |
|---|---|---|---|---|
| LossReason | form | LossReasonInstance | No | |
| LossReasonId | form | int | No | |
| Reason | form | string | No | |
| Selectable | form | bool | No | |
| AppliedCount | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LossReasonId | form | int | No | |
| Reason | form | string | No | |
| Deleted | form | bool | No | |
| Demo | form | bool | No | |
| Selectable | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | 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 /api/Query/SalesLossReasons HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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:
[
{
LossReason:
{
LossReasonId: 0,
Reason: String,
Deleted: False,
Demo: False,
Selectable: False
},
LossReasonId: 0,
Reason: String,
Selectable: False,
AppliedCount: 0
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}