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

Generates the requested preview using the provided rug components.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pal

The comma delimitted list of yarn codes composing the rugs palette. ex: pal=COLOR_CODE1,COLOR_CODE2,COLOR_CODE3

string

Required

designs

The comma delimitted list of design codes used in the rug. ex: designs=BORDER_CODE,CORNER_CODE,FIELD_CODE

string

Required

pos

The comma delimitted list of palette indices used in each design. ex: pos=0,1,2|0,1,1|2,1,0

string

Required

sections

The comma delimitted list of rug component sections. FILL=3 FIELD=2 BORDER=5 CORNER=4. ex: sections=5,4,2

string

Required

scales

The comma delimitted list of pattern scales. ex: scales=1,1,1

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 rug preview.

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.