GET rug/rooms/{roomId}?pal={pal}&designs={designs}&pos={pos}&sections={sections}&scales={scales}&texture={texture}&pixels={pixels}

Generates the requested room scene using the provided rug components.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
roomId

The RoomId indicating which room scene should be used.

integer

Required

pal

The comma delimitted list of yarn codes composing the rugs palette.

string

Required

designs

The comma delimitted list of design codes used in the rug.

string

Required

pos

The serialized list of palette positions used in each design.

string

Required

sections

The comma delimitted list of rug component sections.

string

Required

scales

The comma delimitted list of pattern scales.

string

Required

texture

The optional custom texture to use when recoloring.

integer

Default value is 0

pixels

The pixel size of the output.

string

Default value is

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.