All Verbs | /service/QueryRetailerGoals |
---|
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 |
---|---|---|---|---|
VendorID | form | string | No | |
VendorName | form | string | No | |
VendorGroup | form | string | No | |
CategoryID | form | string | No | |
Category | form | string | No | |
CustomerID | form | string | No | |
CompanyName | form | string | No | |
SalesGoalThisYear | form | decimal | No | |
SalesGoalThisYearTD | form | decimal | No | |
SalesGoalLastYear | form | decimal | No | |
SalesGoalThisQuarter | form | decimal | No | |
SalesGoalLastQuarter | form | decimal | No | |
SalesGoalThisMonth | form | decimal | No | |
SalesGoalLastMonth | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | 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/QueryRetailerGoals HTTP/1.1
Host: www.bernhardthospitality.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: [ { vendorID: String, vendorName: String, vendorGroup: String, categoryID: String, category: String, customerID: String, companyName: String, salesGoalThisYear: 0, salesGoalThisYearTD: 0, salesGoalLastYear: 0, salesGoalThisQuarter: 0, salesGoalLastQuarter: 0, salesGoalThisMonth: 0, salesGoalLastMonth: 0, id: String } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }