GET designs/{designCode}/recolor/installs/{installId}?yarns={yarns}&refColor={refColor}&texture={texture}&physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}

Generates the top down install using the custom colorway and the specified installation method.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
designCode

The design code.

string

Required

installId

The InstallId used to represent the installation method.

integer

Required

yarns

The comma delimitted list of yarn codes to recolor with.

string

Default value is

refColor

The optional reference colorway to use.

string

Default value is

texture

The optional TextureId to use.

integer

Default value is 0

physWidth

The physical width of the output (e.g. 72in, 6.5ft, 150cm).

string

Default value is 72in

physHeight

The physical height of the output (e.g. 72in, 6.5ft, 150cm).

string

Default value is 72in

pixels

The pixel size of the output.

string

Default value is

rgbs

Optional RGB palette to use when recoloring.

string

Default value is

clutColorwayId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Returns a top down installation image for the design's default colorway.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.