Dulux Group API Service

<back to all web services

CategoryColours

The following routes are available for this service:
GET/CategoryColours/{BrandName}/{DeviceName}/Category/{FriendlyCategoryName}
GET/CategoryColours/{BrandName}/{DeviceName}/Range/{FriendlyRangeName}/Category/{FriendlyCategoryName}
CategoryColours Parameters:
NameParameterData TypeRequiredDescription
BrandNamepathstringNo
FriendlyRangeNamepathstringNo
FriendlyCategoryNamepathstringNo
DeviceNamepathDeviceNo
Skipqueryint?No
Takequeryint?No
CategoryColoursResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NameformstringNo
NameStrippedformstringNo
RangeNameformstringNo
RangeNameStrippedformstringNo
CategoryColoursformIList<CategoryColour>No
CategoryColour Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CategoryNameStrippedformstringNo
RangeNameStrippedformstringNo
PositionXformstringNo
PositionYformstringNo
MasterColourformCategoryMasterColourNo
CategoryMasterColour Parameters:
NameParameterData TypeRequiredDescription
CategoryNameStrippedformstringNo
RangeNameStrippedformstringNo
ColoursformIList<Colour>No
MasterColour Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CodeformstringNo
NameformstringNo
NameStrippedformstringNo
SpecifierNumberformstringNo
ChipNumberformstringNo
ChipPositionformstringNo
ChipBarcodeformstringNo
ValidFromformDateTime?No
ValidToformDateTime?No
Colour Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
Redformint?No
Greenformint?No
Blueformint?No
LRVformint?No
MaskformMaskNo
BaseIdformstringNo
NameformstringNo
WoodTypeformstringNo
CoatsformstringNo
ColourSchemeformColourSchemeNo
Mask Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
UrlformstringNo
ThumbnailUrlformstringNo
ColourScheme Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
TypeformstringNo
DescriptionformstringNo
MasterColourIdformstringNo
ColourSchemeMasterColoursformList<ColourSchemeMasterColour>No
MasterColourResponse Parameters:
NameParameterData TypeRequiredDescription
ColoursformList<Colour>No
RelatedMasterColoursformList<RelatedMasterColours>No
LinkedColourCardsformList<ColourCardForMasterColour>No
LinkedImagesformList<ImageForMasterColour>No
LinkedColourSchemesformList<ColourScheme>No
LinkedProductsformList<Product>No
RangeNameformstringNo
RangeNameStrippedformstringNo
CategoryNameformstringNo
CategoryNameStrippedformstringNo
RelatedMasterColours Parameters:
NameParameterData TypeRequiredDescription
RangeNameformstringNo
RangeNameStrippedformstringNo
CategoryNameformstringNo
CategoryNameStrippedformstringNo
PositionXformintNo
PositionYformintNo
ColoursformList<Colour>No
ColourCard Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
Image Parameters:
NameParameterData TypeRequiredDescription
Idformint?No
NameformstringNo
DescriptionformstringNo
UrlformstringNo
OrientationformstringNo
LocationsformstringNo
SourceformstringNo
Widthformint?No
Heightformint?No
Sizeformint?No
CopyrightformstringNo
TagsformstringNo
TagsArrayformstring[]No
Product Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
NameStrippedformstringNo
DescriptionformstringNo
ProductTypeformstringNo
RangeNameformstringNo
RangeNameStrippedformstringNo
IndexOrderformint?No

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

{"brandName":"String","friendlyRangeName":"String","friendlyCategoryName":"String","deviceName":0,"skip":0,"take":0}
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"}},"name":"String","nameStripped":"String","rangeName":"String","rangeNameStripped":"String"}