All Verbs | /service/QueryBadgeScans |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | 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 |
---|---|---|---|---|
Id | form | string | No | |
BadgeId | form | string | No | |
Data | form | JsonObject | No | |
ShowCode | form | string | No | |
ScannedOn | form | DateTime | No | |
CompanyName | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Address | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
form | string | No | ||
Provider | form | string | 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/QueryBadgeScans HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: 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: [ { id: String, badgeId: String, data: { String: "String" }, showCode: String, scannedOn: 0001-01-01, companyName: String, firstName: String, lastName: String, address: String, address2: String, city: String, state: String, zip: String, country: String, phone: String, email: String, provider: String } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }