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

Generates the requested room scene using the specified installation associated with the design code in the specified color.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
designCode

The design code.

string

Required

roomId

The RoomId indicating which room scene should be used.

integer

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

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 specified installation for the design code in the specified color.

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.