EMUN1 ASP.NET

<back to all web services

GetProductCatalog

The following routes are available for this service:
All Verbs/service/Catalog/{Id}
All Verbs/service/GetProductCatalog/{Id}
GetProductCatalog Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetProductCatalogResponse Parameters:
NameParameterData TypeRequiredDescription
CatalogformProductCatalogNo
SectionsformIEnumerable<ProductCatalogSection>No
PagesformIEnumerable<ProductCatalogPage>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
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
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

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/Catalog/{Id} HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String
}
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
	}
}