All Verbs | /service/QueryOptionFields | ||
---|---|---|---|
All Verbs | /service/QueryOptionFields/{Id} | ||
All Verbs | /service/QueryOptionGroupFields/{GroupId} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
GroupId | path | 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 | |
Description | form | string | No | |
ModifySku | form | bool | No | |
LineItemField | form | string | No | |
Required | form | bool | No | |
Grouping1 | form | string | No | |
Grouping2 | form | string | No | |
Grouping3 | form | string | No | |
Grouping4 | form | string | No | |
Grouping5 | form | string | No | |
Tab | form | string | No | |
Position | form | int | No | |
DefaultValueId | form | string | No | |
UseProductOptionMultiplier | form | bool | No | |
Values | form | List<OptionFieldValue> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
FieldId | form | string | No | |
Value | form | string | No | |
Grouping1 | form | string | No | |
Grouping2 | form | string | No | |
Grouping3 | form | string | No | |
Grouping4 | form | string | No | |
Grouping5 | 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/QueryOptionFields HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
groupId: 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, description: String, modifySku: False, lineItemField: String, required: False, grouping1: String, grouping2: String, grouping3: String, grouping4: String, grouping5: String, tab: String, position: 0, defaultValueId: String, useProductOptionMultiplier: False, values: [ { id: String, fieldId: String, value: String, grouping1: String, grouping2: String, grouping3: String, grouping4: String, grouping5: String } ], tags: { String: [ String ] } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }