GET designs/{designCode}/arearug?sergeType={sergeType}&sergeColor={sergeColor}&shape={shape}&physWidth={physWidth}&physHeight={physHeight}&offsetX={offsetX}&offsetY={offsetY}&rotation={rotation}&pixels={pixels}

Generates the area rug image using the design's representative colorway.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
designCode

The design code.

string

Required

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).

string

None.

physHeight

The physical height of the rug (e.g. 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

Body Parameters

None.

Response Information

Resource Description

Returns an area rug image for the design's default colorway 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.