EMUN1 ASP.NET

<back to all web services

QueryProductCatalogs

The following routes are available for this service:
All Verbs/service/QueryProductCatalogs
All Verbs/service/QueryPromoSheets
QueryProductCatalogs Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
Onlinequerybool?No
Offlinequerybool?No
TagCriteriaqueryDictionary<string, HashSet<String>>No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductCatalog Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
LabelformstringNo
TypeformstringNo
CoverformstringNo
PositionformintNo
HideB2BformboolNo
RepCustomformboolNo
CreatedByformstringNo
CreatedOnformDateTimeNo
ModifiedOnformDateTimeNo
ExpiresOnformDateTimeNo
PublishOnformDateTimeNo
ActiveformboolNo
VendorIdformstringNo
SectionsformList<ProductCatalogSection>No
TagsformDictionary<string, HashSet<String>>No
AttributesformProductCatalogAttributesNo
LayoutformstringNo
Widthformdouble?No
Heightformdouble?No
FirstPageBlankformbool?No
ArtboardWidthformintNo
ArtboardHeightformintNo
ArtboardPageCountformint?No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
ProductCatalogSection Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CatalogIdformstringNo
LabelformstringNo
CoverformstringNo
PositionformintNo
StartPageNumformint?No
EndPageNumformint?No
PageCountformintNo
ProductCatalogAttributes Parameters:
NameParameterData TypeRequiredDescription
LayoutformstringNo
OffsetPageformstringNo
Heightformdouble?No
Widthformdouble?No
FirstPageBlankformbool?No
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/QueryProductCatalogs HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	search: String,
	online: False,
	offline: False,
	tagCriteria: 
	{
		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,
			label: String,
			type: String,
			cover: String,
			position: 0,
			hideB2B: False,
			repCustom: False,
			createdBy: String,
			createdOn: 0001-01-01,
			modifiedOn: 0001-01-01,
			expiresOn: 0001-01-01,
			publishOn: 0001-01-01,
			active: False,
			vendorId: String,
			sections: 
			[
				{
					id: String,
					catalogId: String,
					label: String,
					cover: String,
					position: 0,
					startPageNum: 0,
					endPageNum: 0,
					pageCount: 0
				}
			],
			tags: 
			{
				String: 
				[
					String
				]
			},
			attributes: 
			{
				layout: String,
				offsetPage: String,
				height: 0,
				width: 0,
				firstPageBlank: False
			},
			layout: String,
			width: 0,
			height: 0,
			firstPageBlank: False,
			artboardWidth: 0,
			artboardHeight: 0,
			artboardPageCount: 0
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}