EMUN1 ASP.NET

<back to all web services

QueryProductTemplates

The following routes are available for this service:
All Verbs/service/QueryProductTemplates
All Verbs/service/QueryProductTemplates/{Id}
All Verbs/service/QueryProductTemplates/euid/{Euid}
QueryProductTemplates Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
BaseQueryDb<T> Parameters:
NameParameterData TypeRequiredDescription
SearchformstringNo
TagCriteriaformDictionary<string, HashSet<String>>No
ContextformstringNo
EuidformGuid?No
Idformint?No
Activeformbool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductTemplate Parameters:
NameParameterData TypeRequiredDescription
SkuformstringNo
UpcformstringNo
CostformdecimalNo
MinimumOrderQtyformdoubleNo
PurchaseIncrementformdoubleNo
VendorIdformstringNo
WholesalePriceformdecimalNo
RetailPriceformdecimalNo
RatioformstringNo
HeightformdoubleNo
WidthformdoubleNo
DepthformdoubleNo
WeightformdoubleNo
ImagesformList<MediaReference>No
DocumentsformList<MediaReference>No
AreasformList<DesignArea>No
TaggedEntity Parameters:
NameParameterData TypeRequiredDescription
TagsformDictionary<string, HashSet<String>>No
EntityXL Parameters:
NameParameterData TypeRequiredDescription
RefIdformstringNo
RatingformdoubleNo
RestrictedformboolNo
EntityLG Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
EntityMD Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
NameformstringNo
TitleformstringNo
ActiveformboolNo
EntitySM Parameters:
NameParameterData TypeRequiredDescription
EuidformGuidNo
EntityXS Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EntityXS<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
CreatedByformstringNo
CreatedOnformDateTimeNo
LastModifiedOnformDateTimeNo
LastModifiedByformstringNo
PositionformintNo
MediaReference Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EuidformGuid?No
LabelformstringNo
DescriptionformstringNo
RealmformstringNo
UrlformstringNo
ContentTypeformstringNo
Heightformdouble?No
Widthformdouble?No
RefIdformstringNo
DesignArea Parameters:
NameParameterData TypeRequiredDescription
CopyFromformGuid?No
SupplierCodeformstringNo
RatioformstringNo
HeightformdoubleNo
WidthformdoubleNo
BleedLineformdouble?No
SafeLineformdouble?No
BackgroundColorformstringNo
DesignformMediaReferenceNo
OverlaysformList<DesignAreaOverlay>No
UnderlaysformList<DesignAreaUnderlay>No
ValueObject Parameters:
NameParameterData TypeRequiredDescription
EuidformGuidNo
LabelformstringNo
DescriptionformstringNo
DesignAreaOverlay Parameters:
NameParameterData TypeRequiredDescription
MediaformMediaReferenceNo
HeightformdoubleNo
WidthformdoubleNo
XformdoubleNo
YformdoubleNo
IsProductImageformboolNo
IsPrintImageformboolNo
CanDesignformboolNo
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/QueryProductTemplates HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	search: String,
	tagCriteria: 
	{
		String: 
		[
			String
		]
	},
	context: String,
	euid: 00000000-0000-0000-0000-000000000000,
	id: 0,
	active: False,
	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: 
	[
		{
			sku: String,
			upc: String,
			cost: 0,
			minimumOrderQty: 0,
			purchaseIncrement: 0,
			vendorId: String,
			wholesalePrice: 0,
			retailPrice: 0,
			ratio: "8:1",
			height: 0,
			width: 0,
			depth: 0,
			weight: 0,
			images: 
			[
				{
					id: 0,
					euid: 00000000-0000-0000-0000-000000000000,
					label: String,
					description: String,
					realm: String,
					url: String,
					contentType: String,
					height: 0,
					width: 0,
					refId: String
				}
			],
			documents: 
			[
				{
					id: 0,
					euid: 00000000-0000-0000-0000-000000000000,
					label: String,
					description: String,
					realm: String,
					url: String,
					contentType: String,
					height: 0,
					width: 0,
					refId: String
				}
			],
			areas: 
			[
				{
					copyFrom: 00000000-0000-0000-0000-000000000000,
					supplierCode: String,
					ratio: "8:1",
					height: 0,
					width: 0,
					bleedLine: 0,
					safeLine: 0,
					backgroundColor: String,
					design: 
					{
						id: 0,
						euid: 00000000-0000-0000-0000-000000000000,
						label: String,
						description: String,
						realm: String,
						url: String,
						contentType: String,
						height: 0,
						width: 0,
						refId: String
					},
					overlays: 
					[
						{
							media: 
							{
								id: 0,
								euid: 00000000-0000-0000-0000-000000000000,
								label: String,
								description: String,
								realm: String,
								url: String,
								contentType: String,
								height: 0,
								width: 0,
								refId: String
							},
							height: 0,
							width: 0,
							x: 0,
							y: 0,
							isProductImage: False,
							isPrintImage: False,
							canDesign: False,
							label: String,
							description: String
						}
					],
					underlays: 
					[
						{
							media: 
							{
								id: 0,
								euid: 00000000-0000-0000-0000-000000000000,
								label: String,
								description: String,
								realm: String,
								url: String,
								contentType: String,
								height: 0,
								width: 0,
								refId: String
							},
							height: 0,
							width: 0,
							x: 0,
							y: 0,
							isProductImage: False,
							isPrintImage: False,
							canDesign: False,
							label: String,
							description: String
						}
					],
					label: String,
					description: String
				}
			],
			tags: 
			{
				String: 
				[
					String
				]
			},
			refId: String,
			rating: 0,
			restricted: False,
			description: String,
			label: String,
			active: False,
			id: 0,
			createdBy: String,
			createdOn: 0001-01-01,
			lastModifiedOn: 0001-01-01,
			lastModifiedBy: String,
			position: 0
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}