Get Collection List (GetList)

Return the list of design collections.

Method Url

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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

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

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		return list of design collections.
		


Expected Response
{
    "success": "true",
    "count": 2,
    "list": [
        {
            "referenceid": "",
            "name": "All Designs",
            "count": 171
        },
        {
            "referenceid": "Star Wars",
            "name": "Star Wars",
            "count": 7
        },
        {
            "referenceid": "DC0007",
            "name": "Embroidery",
            "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.
countintTotal number of available collections under your account.
listarray/listList / Array of Design 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 design collection. Required to perform any activity on design collections.
namestringName of the design collection.
countintNumber of designs in this collection.


Expected Response
<Response>
  <Success>true</Success>
  <Count>2</Count>
  <List>
    <Designcollection>
      <ReferenceID></ReferenceID>
      <Name>All Designs</Name>
      <Count>171</Count>
    </Designcollection>
    <Designcollection>
      <ReferenceID>Star Wars</ReferenceID>
      <Name>Star Wars</Name>
      <Count>7</Count>
    </Designcollection>
    <Designcollection>
      <ReferenceID>DC0007</ReferenceID>
      <Name>Embroidery</Name>
      <Count>1</Count>
    </Designcollection>
  </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 Design 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 design collection. Required to perform any activity on design collections.
NamestringName of the design collection.
CountintNumber of designs in this collection.

		        

            

		
            

		        

			    
Create Collection (Create)

			    Create a new design collection. If design collection already exists with same name then return the error object. 
                                 User must be authentication to perform this activity
			    


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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                Name
                string
                
                true
                Name of the design 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":"DC0014"
}


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 fals eif failed to execute.
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>DC0015</ReferenceID>
</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 fals eif failed to execute.
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 Design to collection. User must be authentication to perform this activity
			    


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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Design Collection ReferenceID.
            

        
            

                Designs
                string
                
                true
                comma separated list of design reference id's.s
            

        
            

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

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Assign the design 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 Design from collection. User must be authentication to perform this activity
			    


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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Design Collection ReferenceID.
            

        
            

                DesignReferenceID
                string
                
                true
                Design ReferenceID for the design 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 design 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" or "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" or "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.

		        

            

		
            

		        

			    
SetSequence (SetSequence)

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


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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Design Collection ReferenceID.
            

        
            

                DesignList
                string
                
                true
                comma separated list of Design ReferenceID for all the designs 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 designs 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". Return true if successfully executed. 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. 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.

		        

            

		
            

		        

			    
Delete Collection (Delete)

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


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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                Design Collection ReferenceID.
            

        
            

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

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Delete the Design 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