Get List of Readies (GetList)

Returns List of readies for user with status set to on

Method Url

https://client.livedesignerfusion.com/{username}/Ready/GetList 

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                {username}{username}
                string
                
                true
                replace {username} with your fusion username in the method url before sending the request.
            

        
            

                StartIndex
                int
                1
                false
                start index of resultset
            

        
            

                RecordCount
                int
                200
                false
                total resultset size
            

        
            

                Tags
                string
                
                false
                List of tags to filter resultset
            

        
            

                SearchText
                string
                
                false
                SearchText to filter resultset
            

        
            

                Format
                string
                xml
                false
                output format. available format's XML,json,jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Returns List of readies
		


Expected Response
{
    "success": "true",
    "count": 2,
    "list": [
        {
            "referenceid": "R001153",
            "token": "READY-1139",
            "thumbnail_url": "http://assets.livedesignerfusion.com/64820fb6585b7d343518d0cf887be832d8e.png",
            "name": "",
            "tags": [],
            "auto_saved": false,
            "state": "Active"
        },
        {
            "referenceid": "R001152",
            "token": "Imprint-Polo",
            "thumbnail_url": "http://assets.livedesignerfusion.com/6583ba965be625c4d339195a0803b0f05a3.png",
            "name": "",
            "tags": [],
            "auto_saved": false,
            "state": "Active"
        }
   ]
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Return true if successfully executed and return false if failed to execute.
countintNumber of total readies available for the user.
listarray/listArray / List of readies.

See object for more details
list
NameTypeDescription
referenceidstringunique identifier for ready.
namestringName of the ready defined during ready creation process.
tokenstring The ReadyToken for ready. This is required to perform any operation for readies.
tagsArray of stringsList of tags associated with ready.
thumbnail_urlstringif image is cached this is the path of thumbnail image.
statestringready current state (Active.Create).


Expected Response
<Response>
  <Success>true</Success>
  <Count>2</Count>
  <List>
    <Ready>
      <ReferenceID>R001153</ReferenceID>
      <Token>READY-1139</Token>
      <ThumbnailUrl>http://assets.livedesignerfusion.com/64820fb6585b7d343518d0cf887be832d8e.png</ThumbnailUrl>
      <Name>Polo Shirt</Name>
      <Tags />
      <AutoSaved>false</AutoSaved>
      <State>Active</State>
    </Ready>
    <Ready>
      <ReferenceID>R001104</ReferenceID>
      <Token>3x3 Scale</Token>
      <ThumbnailUrl>http://assets.livedesignerfusion.com/47894c58188adc44a3d81461d69d24447f3.png</ThumbnailUrl>
      <Name>3x3 Scale</Name>
      <Tags />
      <AutoSaved>false</AutoSaved>
      <State>Active</State>
    </Ready>
  </List>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true", "false". Return true if successfully executed and return false if failed to execute.
CountintNumber of total readies available for the user.
Listarray/listArray / List of readies.

See object for more details
List
NameTypeDescription
ReferenceIDstringunique identifier for ready.
NamestringName of the ready defined during ready creation process.
Tokenstring The ReadyToken for ready. This is required to perform any operation for readies.
TagsArray of stringsList of tags associated with ready.
ThumbnailUrlstringif image is cached this is the path of thumbnail image.
Statestringready current state (Active.Create).

		        

            

		
            

		        

			    
Get Ready Definition (GetDefinition)

			    Return the ready meta data.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Ready/GetDefinition?parameterlist
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Ready unique identifier.
            

        
            

                Format
                string
                xml
                false
                output format (xml.json,jsonp).
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		return the object with ready meta data with all the properties ( Blank, Elements List etc).
		


Expected Response
{
    "success": "true",
    "definition": {
        "referenceid": "R001327",
        "active": true,
        "name": "Case2181-Emb Elements",
        "tags": [],
        "token": "READY-1326",
        "elements": [
            {
                "elementid": 4153,
                "name": "Text1",
                "element_type": "Lettering",
				"transform":{
					"a":0.60382604598999023,
					"b":0,
					"c":0,
					"d":0.60382604598999023,
					"tx":315,
					"ty":501.05,
					"preSpace":0,
					"postSpace":0,
					"textWidth":0
				},
                "lettering_params": {
                    "character_height": 254,
                    "show_font_collection": true,
                    "show_color_collection": true,
                    "fontcollection_referenceid": "1",
                    "default_font_referenceid": "F00080",
                    "colorcollection_referenceid": "48",
                    "default_color_referenceid": "0082FF00018",
                    "arc_radius": 762,
                    "arc_ccw": false,
                    "monogram": false,
                    "monogram_height1": 0,
                    "monogram_height2": 0,
                    "monogram_height3": 0,
					"text_list": [
                        {
                            "show_prompt": true,
                            "prompt": "Enter Your First Name",
                            "text": "TEXT",
                            "show_text_input": true,
                            "show_character_limit": true,
                            "character_limit": 10
                        },
						{
                            "show_prompt": true,
                            "prompt": "Enter Your Last Name",
                            "text": "TEXT",
                            "show_text_input": true,
                            "show_character_limit": true,
                            "character_limit": 10
                        }
                    ],
					"show_justifictaion": true
                }
            },
            {
                "elementid": 4152,
                "name": "Text2",
                "element_type": "Lettering",
                "lettering_params": {
                    "character_height": 254,
                    "show_font_collection": true,
                    "show_color_collection": true,
                    "fontcollection_referenceid": "1",
                    "default_font_referenceid": "F00080",
                    "colorcollection_referenceid": "48",
                    "default_color_referenceid": "0082FF00018",
                    "arc_radius": 762,
                    "arc_ccw": false,
                    "monogram": false,
                    "monogram_height1": 0,
                    "monogram_height2": 0,
                    "monogram_height3": 0,
					"text_list": [
                        {
                            "show_prompt": true,
                            "prompt": "Enter Your First Name",
                            "text": "TEXT",
                            "show_text_input": true,
                            "show_character_limit": true,
                            "character_limit": 10
                        },
						{
                            "show_prompt": true,
                            "prompt": "Enter Your Last Name",
                            "text": "TEXT",
                            "show_text_input": true,
                            "show_character_limit": true,
                            "character_limit": 10
                        }
                    ]
                }
            },
            {
                "elementid": 4155,
                "name": "Design1",
                "element_type": "StaticDesign",
                "design_referenceid": "D000301",
                "design_name": "Mickey"
            },
            {
                "elementid": 4154,
                "name": "SelectableDesign1",
                "element_type": "SelectableDesign",
                "design_params": {
                    "show_design_collection": true,
                    "designcollection_referenceid": "540",
                    "designcollection_name": "540",
                    "show_prompt": true,
                    "prompt": "Select Design",
                    "default_design_referenceid": "D000301",
                    "enable_user_uploaded": false,
                    "show_user_uploaded_propmt": true,
                    "user_uploaded_propmt": "Upload Design",
                    "design_area_width": 1016,
                    "design_area_height": 1016,
                    "scale_to_fit": "Always"
                }
            }
        ]
    }
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Return true if successfully executed and return false if failed to execute.
definitionobject/nodedata object with ready properties.
error_codestringonly available if failed to execute. This is error identifier. refer to error code list for more details.
error_messagestringonly available if failed to execute. This is detailed message for the error.


Expected Response
<Response>
  <Success>true</Success>
  <Definition>
    <ReferenceID>R001327</ReferenceID>
    <Active>true</Active>
    <Name>Case2181-Emb Elements</Name>
    <Tags />
    <Token>READY-1326</Token>
    <Elements>
      <Element>
        <ElementID>4153</ElementID>
        <Name>Text1</Name>
        <ElementType>Lettering</ElementType>
		<Transform>
			<A>0.60382604598999023</A>
			<B>0</B>
			<C>0</C>
			<D>0.60382604598999023</D>
			<Tx>315</Tx>
			<Ty>501.05</Ty>
			<Prespace>0</Prespace>
			<Postspace>0</Postspace>
			<Textwidth>0</Textwidth>
		</Transform>
        <LetteringParams>
          <CharacterHeight>254</CharacterHeight>
          <ShowFontCollection>true</ShowFontCollection>
          <ShowColorCollection>true</ShowColorCollection>
          <FontCollectionReferenceID>1</FontCollectionReferenceID>
          <DefaultFontReferenceID>F00080</DefaultFontReferenceID>
          <ColorcollectionReferenceID>48</ColorcollectionReferenceID>
          <DefaultColorReferenceID>0082FF00018</DefaultColorReferenceID>
          <ArcRadius>762.000</ArcRadius>
          <ArcCcw>false</ArcCcw>
          <Monogram>false</Monogram>
          <MonogramHeight1>0</MonogramHeight1>
          <MonogramHeight2>0</MonogramHeight2>
          <MonogramHeight3>0</MonogramHeight3>
		  <TextList>
			<Text>
				<ShowPrompt>true</ShowPrompt>
				<Prompt>Enter Your First Name</Prompt>
				<Text>TEXT</Text>
				<ShowTextInput>true</ShowTextInput>
				<ShowCharacterLimit>true</ShowCharacterLimit>
				<CharacterLimit>10</CharacterLimit>
			</Text>
			<Text>
				<ShowPrompt>true</ShowPrompt>
				<Prompt>Enter Your Last Name</Prompt>
				<Text>TEXT</Text>
				<ShowTextInput>true</ShowTextInput>
				<ShowCharacterLimit>true</ShowCharacterLimit>
				<CharacterLimit>10</CharacterLimit>
			</Text>
		</TextList>
        </LetteringParams>
      </Element>
      <Element>
        <ElementID>4152</ElementID>
        <Name>Text2</Name>
        <ElementType>Lettering</ElementType>
        <LetteringParams>
          <CharacterHeight>254</CharacterHeight>
          <ShowFontCollection>true</ShowFontCollection>
          <ShowColorCollection>true</ShowColorCollection>
          <FontCollectionReferenceID>1</FontCollectionReferenceID>
          <DefaultFontReferenceID>F00080</DefaultFontReferenceID>
          <ColorcollectionReferenceID>48</ColorcollectionReferenceID>
          <DefaultColorReferenceID>0082FF00018</DefaultColorReferenceID>
          <ArcRadius>762.000</ArcRadius>
          <ArcCcw>false</ArcCcw>
          <Monogram>false</Monogram>
          <MonogramHeight1>0</MonogramHeight1>
          <MonogramHeight2>0</MonogramHeight2>
          <MonogramHeight3>0</MonogramHeight3>
		  <TextList>
			<Text>
				<ShowPrompt>true</ShowPrompt>
				<Prompt>Enter Your First Name</Prompt>
				<Text>TEXT</Text>
				<ShowTextInput>true</ShowTextInput>
				<ShowCharacterLimit>true</ShowCharacterLimit>
				<CharacterLimit>10</CharacterLimit>
			</Text>
			<Text>
				<ShowPrompt>true</ShowPrompt>
				<Prompt>Enter Your Last Name</Prompt>
				<Text>TEXT</Text>
				<ShowTextInput>true</ShowTextInput>
				<ShowCharacterLimit>true</ShowCharacterLimit>
				<CharacterLimit>10</CharacterLimit>
			</Text>
		</TextList>
		<ShowJustification>true</ShowJustification>
        </LetteringParams>
      </Element>
      <Element>
        <ElementID>4155</ElementID>
        <Name>Design1</Name>
        <ElementType>StaticDesign</ElementType>
        <DesignReferenceID>D000301</DesignReferenceID>
        <DesignName>Mickey</DesignName>
      </Element>
      <Element>
        <ElementID>4154</ElementID>
        <Name>SelectableDesign1</Name>
        <ElementType>SelectableDesign</ElementType>
        <DesignParams>
          <ShowDesignCollection>true</ShowDesignCollection>
          <DesignCollectionReferenceID>540</DesignCollectionReferenceID>
          <DesignCollectionName>540</DesignCollectionName>
          <ShowPrompt>true</ShowPrompt>
          <Prompt>Select Design</Prompt>
          <DefaultDesignReferenceID>D000301</DefaultDesignReferenceID>
          <EnableUserUploaded>false</EnableUserUploaded>
          <ShowUserUploadedPropmt>true</ShowUserUploadedPropmt>
          <UserUploadedPropmt>Upload Design</UserUploadedPropmt>
          <DesignAreaWidth>1016</DesignAreaWidth>
          <DesignAreaHeight>1016</DesignAreaHeight>
          <ScaleToFit>Always</ScaleToFit>
        </DesignParams>
      </Element>
    </Elements>
  </Definition>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true", "false". Return true if successfully executed and return false if failed to execute.
Definitionobject/nodedata object with ready properties.
ErrorCodestringonly available if failed to execute. This is error identifier. refer to error code list for more details.
ErrorMessagestringonly available if failed to execute. This is detailed message for the error.

		        

            

		
            

		        

			    
Get Ready Image (GetImage)

			    Downloads Ready Image.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Ready/GetImage?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                {username}{username}
                string
                
                true
                replace {username} with your fusion username in the method url before sending the request.
            

        
            

                ReferenceID
                string
                
                true
                ready referenceid returned as referenceid field in GetList.
            

        
            

                Thumbnail
                bool
                false
                false
                Possible values 0 or 1 (true,false).
            

        
            

                Width
                int
                100
                false
                width of requested image.
            

        
            

                Height
                int
                
                false
                Returned image will be scaled down if height exceeds this
            

        
            

                ColorName
                string
                
                false
                The Product color to generate image at, if not specified uses default color
            

        
            

                ViewName
                string
                
                false
                The View to generate image at, if not specified uses default
            

        
            

                E.ElementID.Text or E.ElementName.Text.ElementID.TextorE.ElementName.Text
                string
                
                false
                
                         Change the Ready element text. This is applicable for only Lettering Elements (the element type is lettering).
                         Pass query string variable E.ElementID.Text or E.ElementName.Text (Refer to Ready -> GetDefinition for ElementID/ElementName)
                     
            

        
            

                E.ElementID.Color or E.ElementName.Color.ElementID.ColororE.ElementName.Color
                string
                
                false
                
                         Change Ready element color. This is applicable for only Lettering Elements (the element type is lettering). 
                         Pass query string variable E.ElementID.Color or E.ElementName.Color (Refer to Ready -> GetDefinition for ElementID/ElementName). 
                         Any RGB value is valid for this parameter. Url Encode values before passing.
                     
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            

        

		Returns a Ready Image based on the provided parameters.
		
		        

            

		
            

		        

			    
Get Ready File (GetFile)

			    Returns Production file.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Ready/GetFile?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Unique identifier for the ready you want to download. Refer referenceid field from GetList/GetDifinition
            

        
            

                RotAng
                int
                0
                false
                Rotate all production files by a specified degree. Any integer between 1 and 360 is allowed.
            

        
            

                E.ElementID.Text or E.ElementName.Text.ElementID.TextorE.ElementName.Text
                string
                
                false
                
                         Change Ready element text. This is applicable for only Lettering elements (element type is lettering). 
                         Pass query string variable E.ElementID.Text or E.ElementName.Text (Refer Ready -> GetDefinition for ElementID/ElementName)
                     
            

        
            

                E.ElementID.Color or E.ElementName.Color.ElementID.ColororE.ElementName.Color
                string
                
                false
                
                         Change Ready element color. This is applicable for only Lettering elements (element type is lettering). 
                         Pass query string variable E.ElementID.Color or E.ElementName.Color (Refer Ready -> GetDefinition for ElementID/ElementName). 
                         Any RGB value is valid for this parameter. Url Encode values before passing.
                     
            

        
            

                DPI
                int
                199
                false
                only applicable to raster output files(.png). Max value allowed is 300
            

        
            

                FileIndex
                string
                0
                false
                The index of the production file you would like.
            

        
            

                FileName
                string
                ReadyID.ofm or .eps
                true
                The file name you want to use for the downloaded file.  Important note:  the extension of this file name will determine the actual format of the downloaded fulfillment file.
  • 'Embroidery formats' - ofm, exp, dst
  • 'Vector formats' - eps, png, svg, svgz
  • 'Raster formats' - png, svg, svgz
  • 'Mixed Raster/Vector formats' - png, svg, svgz

            

        
            

                FabricStyle
                string
                
                false
                  This is style unique identifier i.e. style referenceid and this parameter is only applicable to embroidery files. 
                             It will override the blank setting for style. Any invalid value will be discarded i.e. if we don't find the style in our records 
                             then it will apply settings from blank.
                     
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            

        

		Returns a production file for the Ready.
		
		        

            

		
            

		        

			    
Get Fulfillment Archive (GetArchive)

			    Download a zip file with all fulfillment files and information for the specified Ready based on the provided parameters.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Ready/GetArchive?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                {username}{username}
                string
                
                true
                Replace {username} with your fusion username in the method url before sending the request.
            

        
            

                ReferenceID
                string
                
                true
                Unique identifier for the Ready.
            

        
            

                EmbFormat
                string
                ofm
                false
                The extension of the file format you'd like for your embroidery file(s).
  • 'Valid Values' - ofm, exp, dst

            

        
            

                VectorFormat
                string
                svg
                false
                The extension of the file format you'd like for your vector/raster files.
  • 'Valid Values' - svg, svgz, png, eps

            

        
            

                DPI
                int
                300
                false
                If VectorFormat is set to png, the DPI parameter specifies the dots per inch of the output file.
            

        
            

                RotAng
                int
                0
                false
                Rotate all production files by a specified degree. Any integer between 1 and 360 is allowed.
            

        
            

                E.ElementID.Text or E.ElementName.Text.ElementID.TextorE.ElementName.Text
                string
                
                false
                
                         Change the Ready element text. This is applicable for only Lettering Elements (the element type is lettering). 
                         Pass query string variable E.ElementID.Text or E.ElementName.Text (Refer to Ready -> GetDefinition for ElementID/ElementName)
                     
            

        
            

                E.ElementID.Color or E.ElementName.Color.ElementID.ColororE.ElementName.Color
                string
                
                false
                
                         Change Ready element color. This is applicable for only Lettering Elements (the element type is lettering). 
                         Pass query string variable E.ElementID.Color or E.ElementName.Color (Refer to Ready -> GetDefinition for ElementID/ElementName). 
                         Any RGB value is valid for this parameter. Url Encode values before passing.
                     
            

        
            

                FabricStyle
                string
                
                false
                  This is style unique identifier i.e. style referenceid and this parameter is only applicable to embroidery files. 
                             It will override the blank setting for style. Any invalid value will be discarded i.e. if we don't find the style in our records 
                             then it will apply settings from blank.
                     
            

        
            

                E.[Composition Name].FabricStyle.[CompositionName].FabricStyle
                string
                
                false
                  you can use the fabric style parameter to override the settings on each composition level by composition name. 
                             This parameter is only applicable to embroidery files. It will override the blank and ready style setting. 
                             Any invalid value will be discarded i.e. if we don't find the style in our records 
                             then it will apply settings from ready or blank i.e. if ready contains two compositions "Front" and "Back" then you can pass this 
                             parameter as E.Front.FabricStyle=S000012 and  E.Back.FabricStyle=S000013 and output file will be generated by applying styles 
                             for each production file. 
                     
            

        
            

                E.[Composition ReferenceID].FabricStyle.[CompositionReferenceID].FabricStyle
                string
                
                false
                  you can use the fabric style parameter to override the settings on each composition level by composition referenceid. 
                             This parameter is only applicable to embroidery files. It will override the blank and ready style setting. 
                             Any invalid value will be discarded i.e. if we don't find the style in our records 
                             then it will apply settings from ready or blank i.e. if ready contains two compositions "C000001" and "C000002" then you can pass this 
                             parameter as E.C000001.FabricStyle=S000012 and  E.C000002.FabricStyle=S000013 and output file will be generated by applying styles 
                             for each production file. 
                     
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            

        

		Returns a zip file containing production-ready files and information for personalization associated with the provided Ready, based on the parameters provided.
		
		        

            

		
            

		        

			    
Get Ready Tags (GetTags)

			    Return the ready tag list.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Ready/GetTags?parameterlist
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                Format
                string
                xml
                false
                output format (xml.json,jsonp).
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		return the list of ready tags.
		


Expected Response
{
    "success": "true",
    "count": 3,
    "list": [
        {
            "name": "Red",
            "count": 1
        },
        {
            "name": "Polo",
            "count": 1
        },
        {
            "name": "Hot Pad",
            "count": 1
        }
    ]
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Return true if successfully executed and return false if failed to execute.
countintNumber of total tags.
listarray/listdata object with ready properties.
error_codestringonly available if failed to execute. This is error identifier. refer to error code list for more details.
error_messagestringonly available if failed to execute. This is detailed message for the error.


Expected Response
<Response>
  <Success>true</Success>
  <Count>3</Count>
  <List>
    <Tag>
      <Name>Red</Name>
      <Count>1</Count>
    </Tag>
    <Tag>
      <Name>Polo</Name>
      <Count>1</Count>
    </Tag>
    <Tag>
      <Name>Hot Pad</Name>
      <Count>1</Count>
    </Tag>
  </List>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true", "false". Return true if successfully executed and return false if failed to execute.
CountintNumber of total tags.
Listarray/listdata object with ready properties.
ErrorCodestringonly available if failed to execute. This is error identifier. refer to error code list for more details.
ErrorMessagestringonly available if failed to execute. This is detailed message for the error.

		        

            

		
		

		
	


        
Version: 3.6.277.0