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

GetInfo

Format

/api/[design component]/GetInfo

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

Description

Returns the design information about the specified design component.

Parameters

Settings

• GetInfoShowAllStops
• By default, will show a consolidated list of stop or color changes information and total thread for each color.
• If Needle 2 is Blue and Needle 10 is Blue, the default will only show Needle 2 with the total thread used from 2 and 10.
• When enabled, it will show all stops or color changes regardless if the same needle is used in multiple cases in one design.
• Valid values are:
• true
• false
Default is false.

Example

/api/Lettering/GetInfo?Text=ABC

Sample Output from BaseballTemplate.PXF

{
	"GetInfoResponse": {
		"Info": {
			"Width": "577",
			"Height": "644",
			"NumStitches": "11780",
			"NumTrims": "9",
			"Left": "-2",
			"Top": "-6",
			"Right": "575",
			"Bottom": "638",
			"Recipe": "Normal",
			"MachineFormat": "EDTSetting03",
			"MasterDensity": "40",
			"NumElements": "4",
			"TextElements": {
				"Elements": [
					{
						"Name": "School Name:Cumber High"
					},
					{
						"Name": "Sport Name:BASEBALL"
					},
					{
						"Name": "Text Line 2:VARSITY"
					}
				]
			},
			"DesignElements": {
				"Elements": {
					"Name": "Mascot"
				}
			},
			"Palette": {
				"Thread": [
					{
						"Name": "Black",
						"Code": "2296",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "28",
						"Green": "38",
						"Blue": "48",
						"Type": "ttCotton"
					},
					{
						"Name": "Metal",
						"Code": "2407",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "102",
						"Green": "109",
						"Blue": "112",
						"Type": "ttCotton"
					},
					{
						"Name": "Snow White",
						"Code": "2297",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "250",
						"Green": "250",
						"Blue": "255",
						"Type": "ttCotton"
					},
					{
						"Name": "Tuxedo Red",
						"Code": "2420",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "214",
						"Green": "40",
						"Blue": "40",
						"Type": "ttCotton"
					},
					{
						"Name": "Pro Red",
						"Code": "2623",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "175",
						"Green": "30",
						"Blue": "45",
						"Type": "ttCotton"
					},
					{
						"Name": "Platinum",
						"Code": "2571",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "193",
						"Green": "181",
						"Blue": "165",
						"Type": "ttCotton"
					},
					{
						"Name": "Yellow",
						"Code": "2213",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "252",
						"Green": "163",
						"Blue": "17",
						"Type": "ttCotton"
					},
					{
						"Name": "Paprika",
						"Code": "2236",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "249",
						"Green": "86",
						"Blue": "2",
						"Type": "ttCotton"
					},
					{
						"Name": "Merit Gold",
						"Code": "2463",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "252",
						"Green": "181",
						"Blue": "20",
						"Type": "ttCotton"
					},
					{
						"Name": "Mid Windsor",
						"Code": "2520",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "0",
						"Green": "163",
						"Blue": "221",
						"Type": "ttCotton"
					},
					{
						"Name": "Bitteroot",
						"Code": "2509",
						"Manufacturer": "R-A SSR-7",
						"Thickness": "3",
						"Red": "252",
						"Green": "94",
						"Blue": "114",
						"Type": "ttCotton"
					}
				]
			},
			"Needles": {
				"Needle": [
					"1",
					"0",
					"1",
					"0",
					"2",
					"3",
					"4",
					"5",
					"1",
					"0",
					"3",
					"0",
					"3",
					"2",
					"0",
					"2",
					"0"
				]
			},
			"Stops": {
				"Stop": [
					{
						"Needle": "1",
						"NumStitches": "1322",
						"ThreadName": "Metal",
						"ThreadUsed": "62736.949793574757",
						"ThreadManufacturer": "R-A SSR-7"
					},
					{
						"Needle": "0",
						"NumStitches": "4098",
						"ThreadName": "Black",
						"ThreadUsed": "140395.23827408167",
						"ThreadManufacturer": "R-A SSR-7"
					},
					{
						"Needle": "2",
						"NumStitches": "3350",
						"ThreadName": "Snow White",
						"ThreadUsed": "129016.40996815829",
						"ThreadManufacturer": "R-A SSR-7"
					},
					{
						"Needle": "3",
						"NumStitches": "2512",
						"ThreadName": "Tuxedo Red",
						"ThreadUsed": "87424.170329240937",
						"ThreadManufacturer": "R-A SSR-7"
					},
					{
						"Needle": "4",
						"NumStitches": "322",
						"ThreadName": "Pro Red",
						"ThreadUsed": "12467.207204150152",
						"ThreadManufacturer": "R-A SSR-7"
					},
					{
						"Needle": "5",
						"NumStitches": "176",
						"ThreadName": "Platinum",
						"ThreadUsed": "6290.6276914196787",
						"ThreadManufacturer": "R-A SSR-7"
					}
				]
			},
			"StartLocation": "sslCentre",
			"StopLocation": "sslCentre",
			"UserDefinedStartPointX": "0",
			"UserDefinedStartPointY": "0",
			"UserDefinedStopPointX": "0",
			"UserDefinedStopPointY": "0",
			"StartOffsetX": "0",
			"StartOffsetY": "0",
			"StopOffsetX": "0",
			"StopOffsetY": "0",
			"StartStopAlignment": "ssatNone"
		}
	}
}

---