Dulux Group API Service

<back to all web services

ProductFilter

The following routes are available for this service:
POST/ProductFilter/{BrandName}/Products
ProductFilter Parameters:
NameParameterData TypeRequiredDescription
BrandNamepathstringNo
FilterBodybodyList<FilterItems>No
FilterItems Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
valuesformList<Filter>No
displayformbool?No
friendlyNameformstringNo
Filter Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
Checkedformbool?No
CountformintNo
showOptionformbool?No
FilterResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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/ProductFilter HTTP/1.1 
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net 
Content-Type: text/jsv
Content-Length: length

{
	brandName: String,
	filterBody: 
	[
		{
			name: String,
			values: 
			[
				{
					id: String,
					name: String,
					checked: False,
					count: 0,
					showOption: False
				}
			],
			display: False,
			friendlyName: 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
		}
	}
}