GET designs/{designCode}

Retrieves an overview of a design.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

The overview of the design.

DesignOverview

Name	Description	Type	Additional information
DesignId	Gets or sets the unique identifier for the design.	integer	None.
BrandId	Gets or sets the unique identifier for the design brand.	integer	None.
EngineId	Gets or sets the unique identifier for the type of simulation engine used.	integer	None.
Code	Gets or sets the design code.	string	None.
Name	Gets or sets the design name.	string	None.
RepeatWidth	Gets or sets the design repeat width.	decimal number	None.
RepeatHeight	Gets or sets the design repeat height.	decimal number	None.
DisplayRepeatSize	Gets or sets the repeat size formatted for display.	string	None.
EnableTryk	Gets or sets a value indicating whether Tryk samples are available or not.	boolean	None.
EnablePhysicalSample	Gets or sets a value indicating whether physical samples are available or not.	boolean	None.
Recolorable	Gets or sets a value indicating whether the design can be recolored.	boolean	None.
IsBroadloom	Gets or sets a value indicating whether the design can be installed as broadloom.	boolean	None.
IsModular	Gets or sets a value indicating whether the design can be installed as modular.	boolean	None.
CategoryIds	Gets or sets a list of CategoryIds that this design is associated with.	Collection of integer	None.
Tufting	Gets or sets the design tufting properties if available, otherwise this will be null.	TuftingProperties	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "designId": 1,
  "brandId": 2,
  "engineId": 3,
  "code": "sample string 4",
  "name": "sample string 5",
  "repeatWidth": 6.0,
  "repeatHeight": 7.0,
  "displayRepeatSize": "sample string 8",
  "enableTryk": true,
  "enablePhysicalSample": true,
  "recolorable": true,
  "isBroadloom": true,
  "isModular": true,
  "categoryIds": [
    1,
    2
  ],
  "tufting": {
    "construction": {
      "constructionId": 1,
      "name": "sample string 2"
    },
    "machineGauge": {
      "machineGaugeId": 1,
      "name": "sample string 2",
      "gauge": 3.0
    },
    "fiber": {
      "fiberId": 1,
      "name": "sample string 2"
    },
    "stitches": 1.0,
    "pileDensity": 2.0,
    "yarnWeight": 3.0
  }
}

application/xml, text/xml

Sample:

<DesignOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tricycle.Studio.Api.Catalog.Models">
  <BrandId>2</BrandId>
  <CategoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CategoryIds>
  <Code>sample string 4</Code>
  <DesignId>1</DesignId>
  <DisplayRepeatSize>sample string 8</DisplayRepeatSize>
  <EnablePhysicalSample>true</EnablePhysicalSample>
  <EnableTryk>true</EnableTryk>
  <EngineId>3</EngineId>
  <IsBroadloom>true</IsBroadloom>
  <IsModular>true</IsModular>
  <Name>sample string 5</Name>
  <Recolorable>true</Recolorable>
  <RepeatHeight>7</RepeatHeight>
  <RepeatWidth>6</RepeatWidth>
  <Tufting>
    <Construction>
      <ConstructionId>1</ConstructionId>
      <Name>sample string 2</Name>
    </Construction>
    <Fiber>
      <FiberId>1</FiberId>
      <Name>sample string 2</Name>
    </Fiber>
    <MachineGauge>
      <Gauge>3</Gauge>
      <MachineGaugeId>1</MachineGaugeId>
      <Name>sample string 2</Name>
    </MachineGauge>
    <PileDensity>2</PileDensity>
    <Stitches>1</Stitches>
    <YarnWeight>3</YarnWeight>
  </Tufting>
</DesignOverview>