All Verbs | /service/QueryTopCustomers |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ManagerId | 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 |
---|---|---|---|---|
Rank1 | form | long? | No | |
CustomerID | form | string | No | |
CustomerName | form | string | No | |
TYTD | form | double? | No | |
Variance1 | form | double? | No | |
Rank2 | form | long? | No | |
CustomerID2 | form | string | No | |
CustomerName2 | form | string | No | |
SalesRepID2 | form | string | No | |
SalesRepName2 | form | string | No | |
LYTotal | form | double? | No | |
Variance2 | form | double? | 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 /service/QueryTopCustomers HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
managerId: 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: [ { rank1: 0, customerID: String, customerName: String, tytd: 0, variance1: 0, rank2: 0, customerID2: String, customerName2: String, salesRepID2: String, salesRepName2: String, lyTotal: 0, variance2: 0 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }