Dulux Group API Service

<back to all web services

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:
NameParameterData TypeRequiredDescription
BrandNamepathstringNo
ImageIdspathIList<int>No
TagNamespathIList<string>No
FriendlyColourNamepathstringNo
CategoryNamepathstringNo
ProductNamepathstringNo
SpaceNamepathstringNo
Skipbodyint?No
Takebodyint?No
IncludeLinkedProductsbodyboolNo
FilterBodybodyIList<FilterItems>No
FilterItems Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
valuesformList<Filter>No
displayformbool?No
friendlyNameformstringNo
Filter Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
Checkedformbool?No
CountformintNo
showOptionformbool?No
ImageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Idformint?No
NameformstringNo
DescriptionformstringNo
UrlformstringNo
OrientationformstringNo
LocationsformstringNo
SourceformstringNo
Widthformint?No
Heightformint?No
Sizeformint?No
CopyrightformstringNo
TagsformstringNo
TagsArrayformstring[]No
ProductFriendlyNameformstringNo
CategoriesformList<CategoriesResponse>No
SpacesformList<SpaceResponse>No
StylesformList<StyleResponse>No
ColoursformList<ImageMasterColours>No
CategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdformintNo
NameformstringNo
NameStrippedformstringNo
RangeNameformstringNo
RangeNameStrippedformstringNo
SpaceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IdformintNo
NameformstringNo
StyleResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ImageMasterColours Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CodeformstringNo
NameformstringNo
NameStrippedformstringNo
SpecifierNumberformstringNo
ChipNumberformstringNo
ChipPositionformstringNo
ChipBarcodeformstringNo
ValidFromformDateTime?No
ValidToformDateTime?No
ColourLocationsformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/Images HTTP/1.1 
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net 
Content-Type: text/csv
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/csv
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":"\/Date(-62135596800000-0000)\/","validTo":"\/Date(-62135596800000-0000)\/","colourLocations":"String"}]}