EMUN1 ASP.NET

<back to all web services

DetectTextProductCatalog

The following routes are available for this service:
All Verbs/service/DetectTextProductCatalog
DetectTextProductCatalog Parameters:
NameParameterData TypeRequiredDescription
BlockTypequerystringNo
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
ProductCatalogTextDetected Parameters:
NameParameterData TypeRequiredDescription
CatalogformProductCatalogNo
HotspotsformList<ProductCatalogHotspot>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

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/DetectTextProductCatalog HTTP/1.1 
Host: www.bernhardt.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	blockType: String,
	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
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	catalog: 
	{
		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
	},
	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
		}
	]
}