EMUN1 ASP.NET

<back to all web services

QueryOptionFields

The following routes are available for this service:
All Verbs/service/QueryOptionFields
All Verbs/service/QueryOptionFields/{Id}
All Verbs/service/QueryOptionGroupFields/{GroupId}
QueryOptionFields Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GroupIdpathstringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
OptionField Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DescriptionformstringNo
ModifySkuformboolNo
LineItemFieldformstringNo
RequiredformboolNo
Grouping1formstringNo
Grouping2formstringNo
Grouping3formstringNo
Grouping4formstringNo
Grouping5formstringNo
TabformstringNo
PositionformintNo
DefaultValueIdformstringNo
UseProductOptionMultiplierformboolNo
ValuesformList<OptionFieldValue>No
TagsformDictionary<string, HashSet<String>>No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
OptionFieldValue Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
FieldIdformstringNo
ValueformstringNo
Grouping1formstringNo
Grouping2formstringNo
Grouping3formstringNo
Grouping4formstringNo
Grouping5formstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}