EMUN1 ASP.NET

<back to all web services

GetProductCatalogPagesByProduct

The following routes are available for this service:
All Verbs/service/GetProductCatalogPagesByProduct
GetProductCatalogPagesByProduct Parameters:
NameParameterData TypeRequiredDescription
CatalogIdquerystringNo
ProductSearchquerystringNo
ProductIdquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductCatalogPage Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CatalogIdformstringNo
SectionIdformstringNo
PageNumformintNo
PositionformintNo
RepCustomformboolNo
MediaIdformstringNo
ModifiedOnformDateTimeNo
LastModifiedOnformDateTimeNo
LabelformstringNo
AttributesformProductCatalogPageAttributesNo
UrlformstringNo
OverviewformstringNo
DescriptionformstringNo
Widthformdouble?No
Heightformdouble?No
TypeformstringNo
PageCountformint?No
LayoutformstringNo
HotspotsformList<ProductCatalogHotspot>No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
ProductCatalogPageAttributes Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EuidformGuid?No
LabelformstringNo
DescriptionformstringNo
OverviewformstringNo
RealmformstringNo
UrlformstringNo
ContentTypeformstringNo
Heightformdouble?No
Widthformdouble?No
RefIdformstringNo
ProductCatalogHotspot Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
PageIdformstringNo
ActionformHotspotActionsNo
ProductIdformstringNo
MediaIdformstringNo
YouTubeIdformstringNo
ExternalResourceformstringNo
LinkedSectionIdformstringNo
LinkedCatalogIdformstringNo
LinkedPageIdformstringNo
MetaformDictionary<string, string>No
ProductIdsformIEnumerable<string>No
OriginalWidthformintNo
OriginalHeightformintNo
LeftformintNo
TopformintNo
RightformintNo
BottomformintNo
WidthformintNo
HeightformintNo
GeneratedformboolNo
RepCustomformboolNo
PositionformintNo
ModifiedOnformDateTimeNo
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/GetProductCatalogPagesByProduct HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	catalogId: String,
	productSearch: String,
	productId: 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,
			catalogId: String,
			sectionId: String,
			pageNum: 0,
			position: 0,
			repCustom: False,
			mediaId: String,
			modifiedOn: 0001-01-01,
			lastModifiedOn: 0001-01-01,
			label: String,
			attributes: 
			{
				id: 0,
				euid: 00000000-0000-0000-0000-000000000000,
				label: String,
				description: String,
				overview: String,
				realm: String,
				url: String,
				contentType: String,
				height: 0,
				width: 0,
				refId: String
			},
			url: String,
			overview: String,
			description: String,
			width: 0,
			height: 0,
			type: String,
			pageCount: 0,
			layout: String,
			hotspots: 
			[
				{
					id: String,
					pageId: String,
					action: None,
					productId: String,
					meta: 
					{
						String: String
					},
					originalWidth: 0,
					originalHeight: 0,
					left: 0,
					top: 0,
					right: 0,
					bottom: 0,
					width: 0,
					height: 0,
					generated: False,
					repCustom: False,
					position: 0,
					modifiedOn: 0001-01-01
				}
			]
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}