GetInfo

Format

/1/GetInfo/[design component]

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

Description

Returns the design information about the specified design component.

Parameters

Format - Format of the returned list. Valid values are "xml" or "json". Default is "xml".

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

Example

/1/GetInfo/Lettering?Text=ABC

Sample Output from BaseballTemplate.PXF

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