Parameters for all requests

• companyid - The companyid is a unique code that is given as part of your subscription to access the API. This code must be supplied as part of the header for each API request.

Refer to the Documentation page for each specific request and the supported Parameters

RenderAll

Format

/api/[design component]/RenderAll

*path is the file that was uploaded to the server using Upload

Design component can be Lettering, a design, a template, a compound or an AutoDigitize.

Description

Returns the design information, rendered file url of the specified design component.

Parameters

• Render Parameters - See Render
• Generate Parameters - Generate Parameters can be passed as Generate.<ParameterName>
  Refer Generate for parameter list
  FileName will be ignored.
• GetInfo Parameters - GetInfo Parameters can be passed as GetInfo.<ParameterName>
  Refer GetInfo for parameter list
• IncludeInfo - Include Info in the response. Valid values are true or false. Default is true
• IncludeRenderedFile - Create a URL to the requested image file and place the file in the location from the Output.EmbroideryFolder configuration. Valid values are true or false. Default is true

Example

/api/Lettering/RenderAll?Text=Pulse

Sample Output

{
    "RenderAllResponse": {
        "Info": {
            "Width": "1777",
            "Height": "1617",
            "NumStitches": "19726",
            "NumTrims": "1",
            "Left": "10",
            "Top": "86",
            "Right": "1787",
            "Bottom": "1703",
            "Recipe": "Normal",
            "MachineFormat": "Tajima",
            "MasterDensity": "40",
            "NumElements": "0",
            "TextElements": "",
            "DesignElements": "",
            "Palette": {
                "Thread": {
                    "Name": "Unknown",
                    "Code": "0",
                    "Manufacturer": "Unknown",
                    "Thickness": "3",
                    "Red": "2",
                    "Green": "2",
                    "Blue": "2",
                    "Type": "ttUnknown"
                }
            },
            "Needles": {
                "Needle": "0"
            },
            "Stops": {
                "Stop": {
                    "Needle": "0",
                    "NumStitches": "19726",
                    "ThreadName": "Unknown",
                    "ThreadUsed": "1111637.9118856031",
                    "ThreadManufacturer": "Unknown"
                }
            },
            "StartLocation": "sslCentre",
            "StopLocation": "sslCentre",
            "UserDefinedStartPointX": "0",
            "UserDefinedStartPointY": "0",
            "UserDefinedStopPointX": "0",
            "UserDefinedStopPointY": "0",
            "StartOffsetX": "0",
            "StartOffsetY": "0",
            "StopOffsetX": "0",
            "StopOffsetY": "0",
            "StartStopAlignment": "ssatNone"
        },
        "GeneratedFile": null,
        "RenderedFile": {
            "Url": "http://localhost:59776/Api/Cached/636876673645500394.png"
        }
    }
}

---