With the /EmbroideryFreeForm endpoint user can render text stitches and submit orders for embroidery free form clients.
POST
/api/EmbroideryFreeForm/GetStitches
Render stitches for a given model
Request Example
Parameters
Common
"AssetType": "Design", // Optional, Possible values: "Design" for Text, Design or Digitize, "Template" for Templates
"Recipe": "Normal", // Optional
"ScaleX": 1, // Required
"ScaleY": 1, // Required
"Type": "TEXT" // Required, Possible values: "TEXT", "DESIGN"
Text
"ArcFactor": 0, // Optional, The value of text property Arc
"EnvelopeType": "Rectangle", // Optional, Possible values: "Rectangle", "BridgeConcaveTop", "BridgeConcaveBottom", "BridgeConvexTop", "DoubleConvexBridges", "ConcaveTopConvexBottom", "ConvexTopConcaveBottom"
"IsDefault": false, // Required, (true for Add Text, false for Edit Text)
"Font": "Block", // Required
"FontHeight": 101.6, // Required, The Font height in mm / 10
"Text": "MY TEXT", // Required
"TextType": "TextTypeRectangle" // Required, Possible values: "TextTypeRectangle", "TextTypeArc"
Design
"Filename": "", // Required, The Design name
"IsTemplate": true, // Required
"Name": "" // Required, The Element name inside the embroidery file. If there are no Elements, its value is the same as "Filename". Get its value from the response of the /api/Designs/GetStitches endpoint
Add Text
[{
"IsDefault": true,
"Properties":
{
"ArcFactor": 0,
"AssetType": "Design",
"EnvelopeType": "Rectangle",
"Font": "Block 2 New",
"FontHeight": 101.6, // Unit: mm / 10
"Recipe": "Normal",
"ScaleX": 1,
"ScaleY": 1,
"Text": "MY TEXT",
"TextType": "TextTypeRectangle"
},
"Type": "TEXT"
}]
Edit Text
[{
"IsDefault": false,
"Properties":
{
"ArcFactor": 0,
"AssetType": "Design",
"EnvelopeType": "Rectangle",
"Font": "Block 2 New",
"FontHeight": 203.2, // Unit: mm / 10
"Recipe": "Normal",
"ScaleX": 2,
"ScaleY": 2,
"Text": "Tajima",
"TextType": "TextTypeRectangle"
},
"Type": "TEXT"
}]
Edit Design
[{
"Properties":
{
"AssetType": "Design",
"Filename": "DesignName",
"IsTemplate": true,
"Name": "ElementName",
"Recipe": "Normal",
"ScaleX": 1,
"ScaleY": 1
},
"Type": "DESIGN"
}]
Response Example
{
"Data":{
"Elements":
[
{
"Name": null,
"Filename": null,
"Text": "MY TEXT",
"TextType": null,
"EnvelopeType": "Rectangle",
"IsText": true,
"IsTemplate": false,
"Fonts": [
{
"Name": "Block"
}
],
"Height": 323.0, // Unit: mm / 10
"Stitches":
[
{
"X": -540, // Unit: mm / 10
"Y": -36, // Unit: mm / 10
"X1": -540, // Unit: mm / 10
"Y1": -30, // Unit: mm / 10
"RelColor": 0, // Used for drawing stitches, The index of the needle (color) in the palette
"Code": 4, // Used for drawing stitches, 0 = sewing, 4 = changing needle (color)
"Jump": 0 // Used for drawing stitches, 0 = sewing, 1 = no sewing
},
...
{
"X": 609, // Unit: mm / 10
"Y": -237, // Unit: mm / 10
"X1": 614, // Unit: mm / 10
"Y1": -240, // Unit: mm / 10
"RelColor": 0, // Used for drawing stitches, The index of the needle (color) in the palette
"Code": 0, // Used for drawing stitches, 0 = sewing, 4 = changing needle (color)
"Jump": 0 // Used for drawing stitches, 0 = sewing, 1 = no sewing
}
],
"Palette": // Available embroidery palette colors
[
{
"Blue": 85,
"Red": 23,
"Green": 52,
"Alpha": 0,
"Code": "1242",
"Name": "Midnight Blue",
"Manufacturer": "MADEIRA CL40 CV_VI",
"RelColor": 0, // Used for drawing stitches, The index of the needle (color) in the palette
"Value": null
},
...
{
"Blue": 43,
"Red": 100,
"Green": 60,
"Alpha": 0,
"Code": "1058",
"Name": "Chocolate",
"Manufacturer": "Madeira Classic Rayon 40",
"RelColor": 0, // Used for drawing stitches, The index of the needle (color) in the palette
"Value": null
}
],
"AssetType": null,
"MinScale": 0.0,
"MaxScale": 0.0,
"ArcFactor": 0
}
]
},
"Success": true,
"Errors": []
}