GET search?c={c}&i={i}&q={q}&r={r}

Used for standard search operations. This will return colorway level results if color categories are provided. This returns a paged result set and allows for custimization of page sizing.

Request Information

URI Parameters

Name	Description	Type	Additional information
c	An optional comma delimitted list of CategoryIds.	string	Default value is
i	An optional comma delimitted list of InstallIds.	string	Default value is
q	An optional search query to filter designs and colors based on their names and codes.	string	Default value is
r	An optional true/false value to indicate whether or not to include recolorable content.	boolean	None.

Body Parameters

None.

Response Information

Resource Description

A paged result set of search results.

Collection of SearchResult

Name	Description	Type	Additional information
DesignId	Gets or sets the unique identifier for the design.	integer	None.
DesignCode	Gets or sets the design code used to identify this design.	string	None.
DesignName	Gets or sets the name of the design.	string	None.
ColorwayId	Gets or sets the unique identifier for the colorway.	integer	None.
ColorCode	Gets or sets the color code used to identify this colorway.	string	None.
ColorName	Gets or sets the name of the colorway.	string	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "items": [
    {
      "designId": 1,
      "designCode": "sample string 2",
      "designName": "sample string 3",
      "colorwayId": 4,
      "colorCode": "sample string 5",
      "colorName": "sample string 6"
    },
    {
      "designId": 1,
      "designCode": "sample string 2",
      "designName": "sample string 3",
      "colorwayId": 4,
      "colorCode": "sample string 5",
      "colorName": "sample string 6"
    }
  ],
  "nextPageLink": null,
  "count": 2
}

application/xml, text/xml

Sample:

<PageResultOfSearchResultTMCXc7Bl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/System.Web.OData">
  <Count>2</Count>
  <NextPageLink i:nil="true" />
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tricycle.Studio.Api.Catalog.Models">
    <d2p1:SearchResult>
      <d2p1:ColorCode>sample string 5</d2p1:ColorCode>
      <d2p1:ColorName>sample string 6</d2p1:ColorName>
      <d2p1:ColorwayId>4</d2p1:ColorwayId>
      <d2p1:DesignCode>sample string 2</d2p1:DesignCode>
      <d2p1:DesignId>1</d2p1:DesignId>
      <d2p1:DesignName>sample string 3</d2p1:DesignName>
    </d2p1:SearchResult>
    <d2p1:SearchResult>
      <d2p1:ColorCode>sample string 5</d2p1:ColorCode>
      <d2p1:ColorName>sample string 6</d2p1:ColorName>
      <d2p1:ColorwayId>4</d2p1:ColorwayId>
      <d2p1:DesignCode>sample string 2</d2p1:DesignCode>
      <d2p1:DesignId>1</d2p1:DesignId>
      <d2p1:DesignName>sample string 3</d2p1:DesignName>
    </d2p1:SearchResult>
  </Items>
</PageResultOfSearchResultTMCXc7Bl>