Get Collection List (GetList)

Return the list of font collections.

Method Url

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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                Format
                string
                xml
                false
                return the result object in this format. Available formts xml,json,jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		return list of font collections.
		


Expected Response
{
    "success": "true",
    "count": 2,
    "list": [
        {
            "referenceid": "",
            "name": "All Fonts",
            "count": 2,
            "fonts": [
                {
                    "referenceid": "F00002",
                    "name": "Style 6 Fishtail",
                    "service": "Embroidery",
                    "alp_type": 0,
                    "file_name": "Style 6 Fishtail.OFA",
                    "font_face": "Style 6 Fishtail"
                },
                {
                    "referenceid": "F00025",
                    "name": "Parseltongue Test",
                    "service": "Printing",
                    "alp_type": 4,
                    "file_name": "PARSEL2.TTF",
                    "font_face": "Parseltongue"
                }
            ]
        },
        {
            "referenceid": "2",
            "name": [
                "Embroidery"
            ],
            "count": 1,
            "fonts": [
                {
                    "referenceid": "Victory Neue 167",
                    "name": "Victory Neue New 123",
                    "service": "Printing",
                    "alp_type": 4,
                    "file_name": "Victory Neue-Bold.ttf",
                    "font_face": "Victory Neue"
                }
            ]
        }
    ]
}


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.
countintTotal number of available collections under your account.
listarray/listList / Array of Font Collections.

See object for more details
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.
list
NameTypeDescription
referenceidstringunique identifier for font collection. Required to perform any activity on font collections.
namestringName of the font collection.
countintNumber of alphabets/fonts in this collection.
fontslist/arrayList of alphabets/fonts in this collection

See object for more details
fonts
NameTypeDescription
referenceidstringunique identifier for font.
namestringfont name.
servicestringService name (embroidery/print).
service_idstringServiceID value.
alp_typestringAlphabet type.
file_namestringFont/Alphabet file name.
font_facestringFont face.


Expected Response
<Response>
  <Success>true</Success>
  <Count>2</Count>
  <List>
    <FontCollection>
      <ReferenceID></ReferenceID>
      <Name>All Fonts</Name>
      <Count>2</Count>
      <Fonts>
        <Font>
          <ReferenceID>F00002</ReferenceID>
          <Name>Style 6 Fishtail</Name>
          <Service>Embroidery</Service>
          <AlpType>0</AlpType>
          <FileName>Style 6 Fishtail.OFA</FileName>
          <FontFace>Style 6 Fishtail</FontFace>
        </Font>
        <Font>
          <ReferenceID>F00023</ReferenceID>
          <Name>Victory Neue New F</Name>
          <Service>Printing</Service>
          <AlpType>4</AlpType>
          <FileName>Victory Neue-Bold.ttf</FileName>
          <FontFace>Victory Neue</FontFace>
        </Font>
      </Fonts>
    </FontCollection>
    <FontCollection>
      <ReferenceID>1</ReferenceID>
      <Name>Print</Name>
      <Count>1</Count>
      <Fonts>
        <Font>
          <ReferenceID>F00002</ReferenceID>
          <Name>bbb</Name>
          <Service>Printing</Service>
          <AlpType>4</AlpType>
          <FileName>comic.ttf</FileName>
          <FontFace>Comic Sans MS</FontFace>
        </Font>
      </Fonts>
    </FontCollection>
  </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.
CountintTotal number of available collections under your account.
Listarray/listList / Array of Font Collections.

See object for more details
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.
List
NameTypeDescription
ReferenceIDstringunique identifier for font collection. Required to perform any activity on font collections.
NamestringName of the font collection.
CountintNumber of alphabets/fonts in this collection.
Fontslist/arrayList of alphabets/fonts in this collection

See object for more details
Fonts
NameTypeDescription
ReferenceIDstringunique identifier for font.
Namestringfont name.
ServicestringService name (embroidery/print).
ServiceIDstringServiceID value.
AlpTypestringAlphabet type.
FileNamestringFont/Alphabet file name.
FontFacestringFont face.

		        

            

		
            

		        

			    
Create Collection (Create)

			    Create a new Font collection. User must be authentication to perform this activity
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/FontCollections/Create?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                Name
                string
                
                true
                Name of the font collection to be created.
            

        
            

                Format
                string
                xml
                false
                output format.  Available formats xml,json,jsonp.
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		return the result object with the following properties
		


Expected Response
{
	"success":"true",
	"referenceid":"FC0014"
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true" and "false"  and "exist". 

Return true if successfully executed  
 return false if failed to execute 
 Return "exist" if the collection with the same name already exists under your account.
referenceidstringReferenceID for the newly created collection.
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>
  <ReferenceID>FC0015</ReferenceID>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true" and "false"  and "exist". 

Return true if successfully executed  
 return false if failed to execute 
 Return "exist" if the collection with the same name already exists under your account.
ReferenceIDstringReferenceID for the newly created collection.
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.

		        

            

		
            

		        

			    
Add To Collection (Add)

			    Add Font/Alphabet to collection. User must be authentication to perform this activity
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/FontCollections/Add?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Font Collection ReferenceID.
            

        
            

                FontList
                string
                
                true
                comma separated list of font reference id's.
            

        
            

                Format
                string
                xml
                false
                return the result object in this format. Available formts xml,json,jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Assign the fonts to collection and return the result object with the following properties
		


Expected Response
{
	"success":"true"
}


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.
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>
</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.
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.

		        

            

		
            

		        

			    
Remove From Collection (Remove)

			    Remove Font/Alphabet from collection. User must be authentication to perform this activity
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/FontCollections/Remove?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Font Collection ReferenceID.
            

        
            

                FontReferenceID
                string
                
                true
                Font ReferenceID for the font to be removed from the collection.
            

        
            

                Format
                string
                xml
                false
                return the result object in this format. Available formts xml,json,jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Remove the font from collection and return the result object with the following properties
		


Expected Response
{
	"success":"true"
}


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.
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>
</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.
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.

		        

            

		
            

		        

			    
SetSequence (SetSequence)

			    Set the Sequence of fonts in the collection. This sequence is used to display fonts to end user. User must be authentication to perform this activity
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/FontCollections/SetSequence?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Font Collection ReferenceID.
            

        
            

                FontList
                string
                
                true
                comma separated list of Font ReferenceID for all the fonts to be seqenced.
            

        
            

                Format
                string
                xml
                false
                return the result object in this format. Available formts xml,json,jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Set the sequence of fonts in the collection and return the result object with the following properties
		


Expected Response
{
	"success":"true"
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false" and "last" 

 Return true if successfully executed 
 Return false if failed to execute. 
 Return "last" if this collection is associated with compositions/readies and you are removing last font from collection because you can't remove all the fonts from referened collection.
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>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true", "false" and "last" 

 Return true if successfully executed 
 Return false if failed to execute. 
 Return "last" if this collection is associated with compositions/readies and you are removing last font from collection because you can't remove all the fonts from referened collection.
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.

		        

            

		
            

		        

			    
Delete Collection (Delete)

			    Delete Font collection and return the result object. User must be authentication to perform this activity
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/FontCollections/Delete?parameters
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Font Collection ReferenceID.
            

        
            

                Format
                string
                xml
                false
                return the result object in this format. Available formts xml,json,jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Delete the font collection and return the result object with the following properties
		


Expected Response
{
	"success":"true"
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Return true if successfully executed else false.
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>
</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 else false.
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