Dulux Group API Service

Images

The following routes are available for this service:
GET, POST	/Images/{BrandName}
GET	/Images/{BrandName}/{ImageIds}
GET	/Images/{BrandName}/{TagNames}
GET	/Images/{BrandName}/Colour/{FriendlyColourName}
GET	/Images/{BrandName}/Category/{CategoryName}
GET	/Images/{BrandName}/Product/{ProductName}
GET	/Images/{BrandName}/Space/{SpaceName}

**Images** Parameters:
Name	Parameter	Data Type	Required
BrandName	path	string	No
ImageIds	path	IList<int>	No
TagNames	path	IList<string>	No
FriendlyColourName	path	string	No
CategoryName	path	string	No
ProductName	path	string	No
SpaceName	path	string	No
Skip	body	int?	No
Take	body	int?	No
IncludeLinkedProducts	body	bool	No
FilterBody	body	IList<FilterItems>	No

**FilterItems** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
values	form	List<Filter>	No
display	form	bool?	No
friendlyName	form	string	No

**Filter** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Checked	form	bool?	No
Count	form	int	No
showOption	form	bool?	No

**ImageResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Id	form	int?	No
Name	form	string	No
Description	form	string	No
Url	form	string	No
Orientation	form	string	No
Locations	form	string	No
Source	form	string	No
Width	form	int?	No
Height	form	int?	No
Size	form	int?	No
Copyright	form	string	No
Tags	form	string	No
TagsArray	form	string[]	No
ProductFriendlyName	form	string	No
Categories	form	List<CategoriesResponse>	No
Spaces	form	List<SpaceResponse>	No
Styles	form	List<StyleResponse>	No
Colours	form	List<ImageMasterColours>	No

**CategoriesResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Id	form	int	No
Name	form	string	No
NameStripped	form	string	No
RangeName	form	string	No
RangeNameStripped	form	string	No

**SpaceResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Id	form	int	No
Name	form	string	No

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

**ImageMasterColours** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Code	form	string	No
Name	form	string	No
NameStripped	form	string	No
SpecifierNumber	form	string	No
ChipNumber	form	string	No
ChipPosition	form	string	No
ChipBarcode	form	string	No
ValidFrom	form	DateTime?	No
ValidTo	form	DateTime?	No
ColourLocations	form	string	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 /jsv/reply/Images HTTP/1.1 
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net 
Content-Type: text/jsv
Content-Length: length

{
	brandName: String,
	friendlyColourName: String,
	categoryName: String,
	productName: String,
	spaceName: String,
	skip: 0,
	take: 0,
	includeLinkedProducts: False
}

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

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	id: 0,
	name: String,
	description: String,
	url: String,
	orientation: String,
	locations: String,
	source: String,
	width: 0,
	height: 0,
	size: 0,
	copyright: String,
	tags: String,
	tagsArray: 
	[
		String
	],
	productFriendlyName: String,
	categories: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			name: String,
			nameStripped: String,
			rangeName: String,
			rangeNameStripped: String
		}
	],
	spaces: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			name: String
		}
	],
	styles: 
	[
		{
			id: 0,
			name: String
		}
	],
	colours: 
	[
		{
			id: String,
			code: String,
			name: String,
			nameStripped: String,
			specifierNumber: String,
			chipNumber: String,
			chipPosition: String,
			chipBarcode: String,
			validFrom: 0001-01-01,
			validTo: 0001-01-01,
			colourLocations: String
		}
	]
}