EMUN1 ASP.NET

<back to all web services

GetCustomOptionFieldValues

The following routes are available for this service:
All Verbs/service/GetCustomOptionFieldValues
All Verbs/service/GetCustomOptionFieldValues/{FieldId}
All Verbs/service/GetCustomOptionFieldValues/{FieldId}/{Id}
All Verbs/service/sales/products/options
All Verbs/service/sales/products/options/{FieldId}
All Verbs/service/sales/products/{ProductId}/options/{FieldId}
All Verbs/service/orders/products/options
All Verbs/service/orders/{OrderNumber}/products/{ProductId}/options/{FieldId}
All Verbs/service/orders/{OrderNumber}/products/{ProductId}/options/{FieldId}/{Id}
GetCustomOptionFieldValues Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
FieldIdpathstringNo
IdpathstringNo
ProductIdpathstringNo
OrderNumberpathstringNo
RetailerIdquerystringNo
SelectionsqueryDictionary<string, string>No
SelectedUpchargesqueryIEnumerable<FieldValue>No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
FieldValue Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
UpchargeTypeformstringNo
Grouping1ValueformstringNo
Grouping2ValueformstringNo
Grouping3ValueformstringNo
Grouping4ValueformstringNo
Grouping5ValueformstringNo
OptionFieldValuePriceListIdformstringNo
CustomValueformboolNo
PriceformdoubleNo
PriceListDescriptionformstringNo
UpchargeformdoubleNo
UpchargeMultiplierformdoubleNo
QtyAvailableformdouble?No
DateAvailableformDateTime?No
RestrictionsformstringNo
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/GetCustomOptionFieldValues HTTP/1.1 
Host: www.bernhardt.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	search: String,
	fieldId: String,
	id: String,
	productId: String,
	orderNumber: String,
	retailerId: String,
	selections: 
	{
		String: 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,
			name: String,
			upchargeType: String,
			grouping1Value: String,
			grouping2Value: String,
			grouping3Value: String,
			grouping4Value: String,
			grouping5Value: String,
			optionFieldValuePriceListId: String,
			customValue: False,
			price: 0,
			priceListDescription: String,
			upcharge: 0,
			upchargeMultiplier: 0,
			qtyAvailable: 0,
			dateAvailable: 0001-01-01,
			restrictions: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}