Dulux Group API Service

Search

The following routes are available for this service:
GET	/Search/{BrandName}/{DeviceName}/All/{QueryName}
GET	/Search/{BrandName}/{DeviceName}/Colours/{ColourName}
GET	/Search/{Take}/{BrandName}/Products/{ProductName}
GET	/Search/{BrandName}/Products/{ProductName}
GET	/Search/{Take}/{BrandName}/{DeviceName}/All/{QueryName}
GET	/Search/{Take}/{BrandName}/{DeviceName}/Colours/{ColourName}

**Search** Parameters:
Name	Parameter	Data Type	Required
Take	path	int	No
BrandName	path	string	No
DeviceName	path	Device	No
QueryName	path	string	No
ColourName	path	string	No
ProductName	path	string	No

**SearchResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
MasterColours	form	IList<MasterColourResponse>	No
Products	form	IList<ProductSearchResponse>	No

**MasterColourResponse** Parameters:
Name	Parameter	Data Type	Required
Colours	form	List<Colour>	No
RelatedMasterColours	form	List<RelatedMasterColours>	No
LinkedColourCards	form	List<ColourCardForMasterColour>	No
LinkedImages	form	List<ImageForMasterColour>	No
LinkedColourSchemes	form	List<ColourScheme>	No
LinkedProducts	form	List<Product>	No
RangeName	form	string	No
RangeNameStripped	form	string	No
CategoryName	form	string	No
CategoryNameStripped	form	string	No

**MasterColour** 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

**Colour** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Red	form	int?	No
Green	form	int?	No
Blue	form	int?	No
LRV	form	int?	No
Mask	form	Mask	No
BaseId	form	string	No
Name	form	string	No
WoodType	form	string	No
Coats	form	string	No
ColourScheme	form	ColourScheme	No

**Mask** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Url	form	string	No
ThumbnailUrl	form	string	No

**ColourScheme** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Type	form	string	No
Description	form	string	No
MasterColourId	form	string	No
ColourSchemeMasterColours	form	List<ColourSchemeMasterColour>	No

**RelatedMasterColours** Parameters:
Name	Parameter	Data Type	Required
RangeName	form	string	No
RangeNameStripped	form	string	No
CategoryName	form	string	No
CategoryNameStripped	form	string	No
PositionX	form	int	No
PositionY	form	int	No
Colours	form	List<Colour>	No

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

**Image** Parameters:
Name	Parameter	Data Type	Required
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

**Product** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
NameStripped	form	string	No
Description	form	string	No
ProductType	form	string	No
RangeName	form	string	No
RangeNameStripped	form	string	No
IndexOrder	form	int?	No

**ProductSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
MSDS	form	string	No
ProductDataSheet	form	List<string>	No

**ProductResponse** Parameters:
Name	Parameter	Data Type	Required
LinkedImages	form	List<Image>	No
LinkedStores	form	List<ProductStores>	No
LinkedMasterColours	form	List<RelatedMasterColours>	No
LinkedVariants	form	List<ProductVariants>	No
LinkedBases	form	List<ProductBases>	No
LinkedProducts	form	List<RelatedProduct>	No

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

**ProductVariants** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Sku	form	string	No
SapId	form	string	No
Image	form	string	No
SizeUnits	form	string	No
SizeValue	form	string	No
IsActive	form	bool	No
IsPurchaseable	form	bool	No

**ProductBases** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Colours	form	List<Colour>	No

**RelatedProduct** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
NameStripped	form	string	No
Description	form	string	No
ProductType	form	string	No
RangeName	form	string	No
LinkedImages	form	List<Image>	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/Search HTTP/1.1 
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net 
Content-Type: text/jsv
Content-Length: length

{
	take: 0,
	brandName: String,
	deviceName: 0,
	queryName: String,
	colourName: String,
	productName: String
}

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
		}
	}
}