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

Start/Stop Parameters

Description

Lettering and compounds can be specify their start/stop locations. Examples include center of the design, first/last stitches, etc.

Parameters

• StartLocation - Location of the start stitch of the design.
• StopLocation - Location of the stop stitch of the design.
• Valid values are:
  • sslFirstStitch - First stitch of the design.
  • sslLastStitch - Last stitch of the design.
  • Please refer to the image below for the following Start/Stop Locations
  • sslTopLeft
  • sslTopCentre
  • sslTopRight
  • sslMiddleLeft
  • sslCentre
  • sslMiddleRight
  • sslBottomLeft
  • sslBottomCentre
  • sslBottomRight
  • sslUserDefined
  • The following parameters are applicable when the Start/Stop are sslUserDefined
  • UserDefinedStartPointX - Valid when StartLocation is set to sslUserDefined.
  • UserDefinedStartPointY - Valid when StartLocation is set to sslUserDefined.
  • UserDefinedStopPointX - Valid when StopLocation is set to sslUserDefined.
  • UserDefinedStopPointY - Valid when StopLocation is set to sslUserDefined.
  • StartOffsetX - X Offset of the start stitch.
  • StartOffsetY - Y Offset of the start stitch.
  • StopOffsetX - X Offset of the stop stitch.
  • StopOffsetY - Y Offset of the stop stitch.
  Default is sslCentre.
• StartStopAlignment - Alignment of the start stitch and the stop stitch. Valid values are:
  • ssatNone
  • ssatAlignStartWithEnd
  • ssatAlignEndWithStart
  Default is ssatNone.

Example

/api/Lettering/Render?Text=Pulse&StartLocation=sslFirstStitch&StopLocation=sslLastStitch

---