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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/CategoryColours HTTP/1.1 
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net 
Content-Type: application/xml
Content-Length: length

<CategoryColours xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DuluxGroup.API.Services.Model">
  <BrandName>String</BrandName>
  <DeviceName>None</DeviceName>
  <FriendlyCategoryName>String</FriendlyCategoryName>
  <FriendlyRangeName>String</FriendlyRangeName>
  <Skip>0</Skip>
  <Take>0</Take>
</CategoryColours>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CategoryColoursResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DuluxGroup.API.Services.Model">
  <CategoryColours i:nil="true" />
  <Name>String</Name>
  <NameStripped>String</NameStripped>
  <RangeName>String</RangeName>
  <RangeNameStripped>String</RangeNameStripped>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CategoryColoursResponse>