GET designs/{designCode}/recolor/rooms/{roomId}?yarns={yarns}&refColor={refColor}&texture={texture}&surfaceRotation={surfaceRotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}

Generates the requested room scene using the default installation associated with the design code in the specified custom colorway.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
designCode

The design code.

string

Required

roomId

The RoomId indicating which room scene should be used.

integer

Required

yarns

The yarns to use when recoloring.

string

Default value is

refColor

The reference colorway to use for specifying a custom threading sequence.

string

Default value is

texture

The optional custom texture to use when recoloring.

integer

Default value is 0

surfaceRotation

An optional value to rotate a scene's surface in degrees.

decimal number

Default value is 0

pixels

The pixel size of the output.

string

Default value is

rgbs

Optional RGB palette to use when recoloring.

string

Default value is

clutColorwayId

Optional Clut Colorway to use when recoloring. Will override all options for recoloring.

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Returns a generated room scene using the default installation for the design code in the specified custom 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.