api/newDesign

Action:

Obtain a single design file of a new set of decorations in a combined design which is created based on the design recipe provided. Returns the actual design data in .EMB format, and/or other supported formats.

Also, optionally generate a transparent TrueView™ image of the decorations as api/newDesignTrueview function. 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 the full specification of the components of design:
<xml>
  <recipe ... /> 			// recipe
  <files ... />				// files used by the recipe
</xml>

Return Values:

On success, an XML string containing the generated design, and optionally its TrueView™ and the design information:

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

Remarks:

The method will create a new composite design combining all the decorations supplied and position them according to the transforms specified by recipe.

It will then produce an embroidery design data file that will be returned in files part of the return value, named according to the design_file parameter of the output component of the recipe.

It will then optionally create a transparent bitmap of the produced design that will be returned in files part of the return value, named according to the trueview_file parameter of the output component of the recipe. It will then create the design information about the produced design that will be returned in design_info part of the return value.