GET designs/{designCode}/colorways/{colorCode}

Retrieves the requested colorway associated with a design code.

Request Information

URI Parameters

Name	Description	Type	Additional information
designCode	The design code associated with the product.	string	Required
colorCode	The color code associated with the product.	string	Required

Body Parameters

None.

Response Information

Resource Description

Colorway

Name	Description	Type	Additional information
DesignId	Gets or sets the unique identifier for the design the colorway belongs to.	integer	None.
ColorwayId	Gets or sets the unique identifier for the colorway.	integer	None.
BrandId	Gets or sets the unique identifier for the brand.	integer	None.
EngineId	Gets or sets the unique identifier for the type of simulation engine used.	integer	None.
DesignCode	Gets or sets the design code this colorway belongs to.	string	None.
DesignName	Gets or sets the design name this colorway belongs to.	string	None.
ColorCode	Gets or sets the color code used to identify this colorway.	string	None.
ColorName	Gets or sets the color name used to identify this colorway.	string	None.
IsDefault	Gets or sets a value indicating whether this is the default colorway for the design.	boolean	None.
TileSizes	Gets or sets a list of tile sizes associated with this colorway.	Collection of ColorwayTileSize	None.
Recolorable	Gets or sets a flag indicating if the colorway can be customized.	boolean	None.
Yarns	Gets or sets a list of yarns used to create the colorway.	Collection of ColorwayYarn	None.

Response Formats

application/json, text/json

Sample:

{
  "designId": 1,
  "colorwayId": 2,
  "brandId": 3,
  "engineId": 4,
  "designCode": "sample string 5",
  "designName": "sample string 6",
  "colorCode": "sample string 7",
  "colorName": "sample string 8",
  "isDefault": true,
  "tileSizes": [
    {
      "colorwayId": 1,
      "count": 2,
      "widthInches": 3.0,
      "heightInches": 4.0
    },
    {
      "colorwayId": 1,
      "count": 2,
      "widthInches": 3.0,
      "heightInches": 4.0
    }
  ],
  "recolorable": true,
  "yarns": [
    {
      "yarnId": 1,
      "yarnTypeId": 2,
      "code": "sample string 3",
      "name": "sample string 4",
      "properties": {
        "isMetallic": true
      },
      "children": [],
      "isLocked": true
    },
    {
      "yarnId": 1,
      "yarnTypeId": 2,
      "code": "sample string 3",
      "name": "sample string 4",
      "properties": {
        "isMetallic": true
      },
      "children": [],
      "isLocked": true
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

text/html

Sample:

Sample not available.