EMUN1 ASP.NET

<back to all web services

QueryProductCatalogHotspots

The following routes are available for this service:
All Verbs/service/QueryProductCatalogHotspots
QueryProductCatalogHotspots Parameters:
NameParameterData TypeRequiredDescription
IdquerystringNo
IdInquerystring[]No
CatalogIdquerystringNo
SectionIdquerystringNo
PageIdquerystringNo
PageIdInquerystring[]No
SearchquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
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
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
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/QueryProductCatalogHotspots HTTP/1.1 
Host: www.bernhardt.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	idIn: 
	[
		String
	],
	catalogId: String,
	sectionId: String,
	pageId: String,
	pageIdIn: 
	[
		String
	],
	search: 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,
			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
		}
	}
}