GET designs/{designCode}/recolor/arearug/rooms/{roomId}?yarns={yarns}&muted={muted}&refLibs={refLibs}&refColor={refColor}&texture={texture}&rgbs={rgbs}&installId={installId}&sergeType={sergeType}&sergeColor={sergeColor}&shape={shape}&physWidth={physWidth}&physHeight={physHeight}&offsetX={offsetX}&offsetY={offsetY}&rotation={rotation}&pixels={pixels}&dl={dl}&args={args}

Generates a room scene image using a recolored area rug image for the requested the design.

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 comma delimitted list of yarn codes to recolor with.

string

Default value is

muted

The optional comma delimitted list of yarn indices to mute.

string

Default value is

refLibs

The optional comma delimited list of master library codes for searching yarns.

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

rgbs

Optional RGB palette to use when recoloring.

string

Default value is

installId

An optional InstallId indicating which install method to use.

integer

Default value is 1

sergeType

The serging type to apply to the edge of the rug.

string

None.

sergeColor

The color of the serging.

string

None.

shape

The shape of the rug (e.g. rectangle, circle)

string

Default value is rectangle

physWidth

The physical width of the rug (e.g. 5ft, 9ft, 12ft).

string

None.

physHeight

The physical height of the rug (e.g. 5ft, 9ft, 12ft).

string

None.

offsetX

An optional horizontal offset as a physical dimension to define a starting point (e.g. 18in).

string

None.

offsetY

An optional vertical offset as a physical dimension to define a starting point (e.g. 3.5in).

string

None.

rotation

An optional rotation specified as degrees to apply to the rug (e.g. 90, 180, 270).

integer

Default value is 0

pixels

The pixel size of the output.

string

Default value is

dl

boolean

Default value is False

args

Extra args for fine tuning.

string

Default value is G0,R0

Body Parameters

None.

Response Information

Resource Description

Returns an area rug image for the requested colorway of the design at the specified physical size.

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.