api/bitmapArtTrueview

Action:

Obtain a transparent TrueView™ image by auto digitizing the bitmap image.

The supported bitmap image formats are listed here:  Bitmap formats

The API removes the background as api/bitmapArtPreview did. And then execute auto digitize task.

Also obtain information about the produced design, such as height, width, number of stitches, etc, as the api/designInfo function.

Post Parameters:

  • appId: Application id of Wilcom API Develop Portal account.
  • appKey: Application key of Wilcom API Develop Portal account.
  • requestXml: an XML string containing a single bitmap file:
<xml>
  <bitmap … />
  <autodigitize_options … />
  <output … />
  <files>
    <file ... />			// bitmap  file.
  </files>
</xml>

Return Values:

On success, an XML string containing the design information:

<xml>
  <files>
    <file ... />			// resulting trueview file
  </files>
  <design_info ... /> 			// estimated design information
</xml>

Remarks:

The bitmap appoints which file will be processed in files . Please read Bitmap Recipe: bitmap XML Data for more information.

The autodigitize_options appoints some options which will be used when auto digitizing Please read Auto Digitize Options Recipe: autodigitize_options XML Data for more information.

The output specifies the output format and version of the function. Please read Output for more information.

The files contains the file name and file content of bitmap files in request which will be processed and created embroidery trueview in the return.   Please read Files: files XML Data for more information.

It will then create the design information about the produced design that will be returned in design_info part of the return value. Please read Design Information: design_info XML Data for more information.

There are some limitations for input bitmap file. Please read Auto digitize limitations.