EMUN1 ASP.NET

ExtendDesign

The following routes are available for this service:
All Verbs	/service/ExtendDesign

**CreateDesignBase** Parameters:
Name	Parameter	Data Type	Required
Underlays	form	List<DesignAreaUnderlay>	No
Overlays	form	List<DesignAreaOverlay>	No
ProductId	form	string	No
AreaIndex	form	int?	No
Contain	form	bool	No
SaveJson	form	bool	No
Renderings	form	List<RenderParams>	No
ExchangeColors	form	Dictionary<string, string>	No
CopyProductImages	form	string	No
Tags	form	Dictionary<string, HashSet<String>>	No

**Design** Parameters:
Name	Parameter	Data Type	Required
Json	form	string	No
Svg	form	string	No
Bitmap	form	string	No
Background	form	string	No
BackgroundColor	form	string	No
OverlayColor	form	string	No
OverlayImage	form	JsonObject	No
BackgroundImage	form	JsonObject	No
Objects	form	JsonArrayObjects	No
Predecessor	form	Media	No
OverlayImages	form	Dictionary<string, Dictionary<String,String>>	No
UnderlayImages	form	Dictionary<string, Dictionary<String,String>>	No

**Media** Parameters:
Name	Parameter	Data Type	Required
PredecessorId	form	int?	No
ReplacePredecessor	form	bool	No
ContentType	form	string	No
Predecessor	form	Media	No
Realm	form	string	No
Height	form	double	No
Width	form	double	No
Area	form	double	No
ContentLength	form	double	No
ClientId	form	string	No
Url	form	string	No
OriginalUrl	form	string	No
Images	form	Dictionary<string, string>	No
Key	form	string	No

**TaggedEntity** Parameters:
Name	Parameter	Data Type	Required	Description
Tags	form	Dictionary<string, HashSet<String>>	No

**EntityXL** Parameters:
Name	Parameter	Data Type	Required
RefId	form	string	No
Rating	form	double	No
Restricted	form	bool	No

**EntityLG** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	No

**EntityMD** Parameters:
Name	Parameter	Data Type	Required
Label	form	string	No
Name	form	string	No
Title	form	string	No
Active	form	bool	No

**EntitySM** Parameters:
Name	Parameter	Data Type	Required	Description
Euid	form	Guid	No

**EntityXS** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No

**EntityXS<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	T	No
CreatedBy	form	string	No
CreatedOn	form	DateTime	No
LastModifiedOn	form	DateTime	No
LastModifiedBy	form	string	No
Position	form	int	No

**DesignAreaOverlay** Parameters:
Name	Parameter	Data Type	Required
Media	form	MediaReference	No
Height	form	double	No
Width	form	double	No
X	form	double	No
Y	form	double	No
IsProductImage	form	bool	No
IsPrintImage	form	bool	No
CanDesign	form	bool	No

**ValueObject** Parameters:
Name	Parameter	Data Type	Required
Euid	form	Guid	No
Label	form	string	No
Description	form	string	No

**MediaReference** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Euid	form	Guid?	No
Label	form	string	No
Description	form	string	No
Realm	form	string	No
Url	form	string	No
ContentType	form	string	No
Height	form	double?	No
Width	form	double?	No
RefId	form	string	No

**RenderParams** Parameters:
Name	Parameter	Data Type	Required
Translate	form	TranslatedDimensions	No
ContainTo	form	ScaledDimensions	No
CopyTo	form	Dictionary<string, HashSet<String>>	No
Label	form	string	No
ClearBackground	form	bool	No
IsPrimary	form	bool	No
ImageType	form	string	No
Quality	form	byte	No
OverlayId	form	string	No
OverlayUrl	form	string	No
UnderlayId	form	string	No
UnderlayUrl	form	string	No
BackgroundColor	form	string	No
Json	form	string	No
Svg	form	string	No
Bitmap	form	string	No
FileName	form	string	No
Slug	form	string	No
MetaKey	form	string	No

**Viewport** Parameters:
Name	Parameter	Data Type	Required	Description
X	form	double	No
Y	form	double	No

**Dimensions** Parameters:
Name	Parameter	Data Type	Required	Description
Height	form	double	No
Width	form	double	No

**TranslatedDimensions** Parameters:
Name	Parameter	Data Type	Required
Cover	form	bool	No
Contain	form	bool	No
To	form	Dimensions	No
LeftOffset	form	double	No
TopOffset	form	double	No
WidthRatio	form	double	No
HeightRatio	form	double	No
Multiplier	form	double	No

**ScaledDimensions** Parameters:
Name	Parameter	Data Type	Required
Cover	form	bool	No
To	form	Dimensions	No
HeightRatio	form	double	No
WidthRatio	form	double	No
Multiplier	form	double	No

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

{
	underlays: 
	[
		{
			media: 
			{
				id: 0,
				euid: 00000000-0000-0000-0000-000000000000,
				label: String,
				description: String,
				realm: String,
				url: String,
				contentType: String,
				height: 0,
				width: 0,
				refId: String
			},
			height: 0,
			width: 0,
			x: 0,
			y: 0,
			isProductImage: False,
			isPrintImage: False,
			canDesign: False,
			label: String,
			description: String
		}
	],
	overlays: 
	[
		{
			media: 
			{
				id: 0,
				euid: 00000000-0000-0000-0000-000000000000,
				label: String,
				description: String,
				realm: String,
				url: String,
				contentType: String,
				height: 0,
				width: 0,
				refId: String
			},
			height: 0,
			width: 0,
			x: 0,
			y: 0,
			isProductImage: False,
			isPrintImage: False,
			canDesign: False,
			label: String,
			description: String
		}
	],
	productId: String,
	areaIndex: 0,
	contain: False,
	saveJson: False,
	renderings: 
	[
		{
			copyTo: 
			{
				String: 
				[
					String
				]
			},
			label: String,
			clearBackground: False,
			isPrimary: False,
			imageType: String,
			quality: 0,
			overlayId: String,
			overlayUrl: String,
			underlayId: String,
			underlayUrl: String,
			backgroundColor: String,
			json: String,
			svg: String,
			bitmap: String,
			fileName: string.string,
			slug: String/string.string,
			metaKey: StringString,
			x: 0,
			y: 0,
			height: 0,
			width: 0
		}
	],
	exchangeColors: 
	{
		String: String
	},
	copyProductImages: String,
	tags: 
	{
		String: 
		[
			String
		]
	},
	overlayImage: 
	{
		String: "String"
	},
	backgroundImage: 
	{
		String: "String"
	},
	objects: 
	[
		{
			String: "String"
		}
	],
	predecessor: 
	{
		predecessorId: 0,
		replacePredecessor: False,
		contentType: String,
		predecessor: 
		{
			predecessorId: 0,
			replacePredecessor: False,
			contentType: String,
			predecessor: 
			{
				predecessorId: 0,
				replacePredecessor: False,
				contentType: String,
				realm: String,
				height: 0,
				width: 0,
				area: 0,
				contentLength: 0,
				clientId: String,
				url: String,
				originalUrl: String,
				key: String,
				tags: 
				{
					String: 
					[
						String
					]
				},
				refId: String,
				rating: 0,
				restricted: False,
				description: String,
				label: String,
				active: False,
				id: 0,
				createdBy: String,
				createdOn: 0001-01-01,
				lastModifiedOn: 0001-01-01,
				lastModifiedBy: String,
				position: 0
			},
			realm: String,
			height: 0,
			width: 0,
			area: 0,
			contentLength: 0,
			clientId: String,
			url: String,
			originalUrl: String,
			key: String,
			tags: 
			{
				String: 
				[
					String
				]
			},
			refId: String,
			rating: 0,
			restricted: False,
			description: String,
			label: String,
			active: False,
			id: 0,
			createdBy: String,
			createdOn: 0001-01-01,
			lastModifiedOn: 0001-01-01,
			lastModifiedBy: String,
			position: 0
		},
		realm: String,
		height: 0,
		width: 0,
		area: 0,
		contentLength: 0,
		clientId: String,
		url: String,
		originalUrl: String,
		key: String,
		tags: 
		{
			String: 
			[
				String
			]
		},
		refId: String,
		rating: 0,
		restricted: False,
		description: String,
		label: String,
		active: False,
		id: 0,
		createdBy: String,
		createdOn: 0001-01-01,
		lastModifiedOn: 0001-01-01,
		lastModifiedBy: String,
		position: 0
	},
	predecessorId: 0,
	replacePredecessor: False,
	contentType: String,
	realm: String,
	height: 0,
	width: 0,
	area: 0,
	contentLength: 0,
	clientId: String,
	url: String,
	originalUrl: String,
	key: String,
	refId: String,
	rating: 0,
	restricted: False,
	description: String,
	label: String,
	active: False,
	id: 0,
	createdBy: String,
	createdOn: 0001-01-01,
	lastModifiedOn: 0001-01-01,
	lastModifiedBy: String,
	position: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	overlayImage: 
	{
		String: "String"
	},
	backgroundImage: 
	{
		String: "String"
	},
	objects: 
	[
		{
			String: "String"
		}
	],
	predecessor: 
	{
		predecessorId: 0,
		replacePredecessor: False,
		contentType: String,
		predecessor: 
		{
			predecessorId: 0,
			replacePredecessor: False,
			contentType: String,
			predecessor: 
			{
				predecessorId: 0,
				replacePredecessor: False,
				contentType: String,
				realm: String,
				height: 0,
				width: 0,
				area: 0,
				contentLength: 0,
				clientId: String,
				url: String,
				originalUrl: String,
				key: String,
				tags: 
				{
					String: 
					[
						String
					]
				},
				refId: String,
				rating: 0,
				restricted: False,
				description: String,
				label: String,
				active: False,
				id: 0,
				createdBy: String,
				createdOn: 0001-01-01,
				lastModifiedOn: 0001-01-01,
				lastModifiedBy: String,
				position: 0
			},
			realm: String,
			height: 0,
			width: 0,
			area: 0,
			contentLength: 0,
			clientId: String,
			url: String,
			originalUrl: String,
			key: String,
			tags: 
			{
				String: 
				[
					String
				]
			},
			refId: String,
			rating: 0,
			restricted: False,
			description: String,
			label: String,
			active: False,
			id: 0,
			createdBy: String,
			createdOn: 0001-01-01,
			lastModifiedOn: 0001-01-01,
			lastModifiedBy: String,
			position: 0
		},
		realm: String,
		height: 0,
		width: 0,
		area: 0,
		contentLength: 0,
		clientId: String,
		url: String,
		originalUrl: String,
		key: String,
		tags: 
		{
			String: 
			[
				String
			]
		},
		refId: String,
		rating: 0,
		restricted: False,
		description: String,
		label: String,
		active: False,
		id: 0,
		createdBy: String,
		createdOn: 0001-01-01,
		lastModifiedOn: 0001-01-01,
		lastModifiedBy: String,
		position: 0
	},
	predecessorId: 0,
	replacePredecessor: False,
	contentType: String,
	realm: String,
	height: 0,
	width: 0,
	area: 0,
	contentLength: 0,
	clientId: String,
	url: String,
	originalUrl: String,
	key: String,
	tags: 
	{
		String: 
		[
			String
		]
	},
	refId: String,
	rating: 0,
	restricted: False,
	description: String,
	label: String,
	active: False,
	id: 0,
	createdBy: String,
	createdOn: 0001-01-01,
	lastModifiedOn: 0001-01-01,
	lastModifiedBy: String,
	position: 0
}