Get Styles List (GetList)

Get List of styles

Method Url

https://client.livedesignerfusion.com/{username}/Styles/GetList?parameterlist 

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                DefaultStyle
                boolean
                false
                false
                This parameter determines if response will contain the Melco provided style files.
            

        
            

                Format
                string
                xml
                false
                Output format. Available format's: XML, json, jsonp
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Returns the list of Styles in the requested format.
		


Expected Response
{
	"success": "true",
	"count": 2,
	"list": [
		{
			"referenceid": "CustomFabricStyle",
			"name": "CustomFabricStyle",
			"file_name": "CustomFabricStyle.ST3",
			"default_style": "false"
		},
		{
			"referenceid": "Fleece",
			"name": "Fleece (Melco)",
			"file_name": "Fleece.fabric.ST3",
			"default_style": "true"
		}
	]
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
countintThe total number of styles avilable (after applicable filters).
listarray/listArray / List of styles.

See object for more details
error_codestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_messagestringOnly available if the call failed to execute. This is a detailed message for the error.
list
NameTypeDescription
referenceidstringThis is the unique identifier for the style and required in all other API calls to download or apply style files to output files.
namestringName of the style.
file_namestringStyle File Name. (i.e. Cotton.st3, Lightweight.st3)
default_stylebooleanPossible values "true", "false". Will return true if this is a default style (Melco provided).  
                                       Will return false if this is the customer's own uploaded file.
                                 


Expected Response
<Response>
  <Success>true</Success>
  <Count>2</Count>
  <List>
    <Style>
      <ReferenceID>CustomFabricStyle</ReferenceID>
      <Name>CustomFabricStyle</Name>
      <FileName>CustomFabricStyle.ST3</FileName>
      <DefaultStyle>false</DefaultStyle>
    </Style>
    <Style>
      <ReferenceID>Fleece</ReferenceID>
      <Name>Fleece (Melco)</Name>
      <FileName>Fleece.fabric.ST3</FileName>
      <DefaultStyle>true</DefaultStyle>
    </Style>
  </List>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
CountintThe total number of styles avilable (after applicable filters).
Listarray/listArray / List of styles.

See object for more details
ErrorCodestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessagestringOnly available if the call failed to execute. This is a detailed message for the error.
List
NameTypeDescription
ReferenceIDstringThis is the unique identifier for the style and required in all other API calls to download or apply style files to output files.
NamestringName of the style.
FileNamestringStyle File Name. (i.e. Cotton.st3, Lightweight.st3)
DefaultStylebooleanPossible values "true", "false". Will return true if this is a default style (Melco provided).  
                                       Will return false if this is the customer's own uploaded file.
                                 

		        

            

		
            

		        

			    
Upload Style (Upload)

			    Import the posted file as style.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Styles/Upload
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true/false
                
                          This is the unique identifer for the uploaded style. It's required if you are updating existing style file and 
                          optional if you are uplaoding as new style i.e. you can assign your own identifer in new style upload. 
                          If value of this parameter isn't provided then application will automatically assign unique identifier.
                    
            

        
            

                Update
                boolean
                false/0
                false
                
                          This parameter determines the behaviour of upload process (new vs. update)
                    
            

        
            

                Name
                string
                
                false
                
                          Name of the Style. Default value will be the file name without file extension.
                    
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Upload / update the posted file as a Style file.
		


Expected Response
{
    "success": "true"
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Will return true if the call successfully executed and will return false if the call failed 
                                 to execute.
error_codestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_messagestringOnly available if the call failed to execute. This is a 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". Will return true if the call successfully executed and will return false if the call failed 
                                 to execute.
ErrorCodestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessagestringOnly available if the call failed to execute. This is a detailed message for the error.

		        

            

		
            

		        

			    
Delete Style (Delete)

			    Removes the selected style.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Styles/Delete?parameterlist
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                The unique identifier, representing the Style you want to delete.
            

        
            

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

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		
		


Expected Response
{
    "success": "true"
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
error_codestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_messagestringOnly available if the call failed to execute. This is a 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". Will return true if the call successfully executed and will return false if the call failed to execute.
ErrorCodestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessagestringOnly available if the call failed to execute. This is a detailed message for the error.

		        

            

		
            

		        

			    
Get Style File (GetFile)

			    Returns the Design file.
			    


			    
Method Url
https://client.livedesignerfusion.com/{username}/Styles/GetFile?parameterlist
			    

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                The unique identifier, representing the Style you want to download.
            

        
            

                Default
                boolean
                false
                false
                 This parameter determines if you are trying to download the style from your account or Melco provided styles.
                            If true, the default (Melco provided) Style file will be returned.  If false, your own uploaded  Style file will be returned.
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            

        

		Returns the requested Style file.
		
		        

            

		
            

		        

			    
Get Style Info (GetDefinition)

			    Returns style file metadata.
			    


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

			    

			    
		
Parameters

		

		

			
				
NameTypeDefaultRequiredDescription

				
            

                ReferenceID
                string
                
                true
                The unique identifier of the style.
            

        
			
		

		

        
		
                

                
                


			    
			    
		
 
            
Output / Result 
                
            
		
            

        

		Returns the requested Style file metadata.
		


Expected Response
{
    "success": "true",
    "definition": {
        "referenceid": "S000011",
        "name": "CustomK.FABRIC",
        "file_name": "CustomK.FABRIC.ST3",
        "default_style": "false",
        "blanks": []
    }
}


Error Response
{
    "success" : "false",
    "error_code" : "MISSING_PARAMETER",
    "error_message" : "Detailed error message"
}
Properties
NameTypeDescription
successstringPossible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
definitionobjectobject with style properties.

See object for more details
error_codestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_messagestringOnly available if the call failed to execute. This is a detailed message for the error.
definition
NameTypeDescription
referenceidstringThe unique identifier of the style.
namestringThe name of the style.
file_namestringThe file name of the style.
default_stylebooleanThis is Melco provided style or not.
blankslist/objectList of associated blanks


Expected Response
<Response>
  <Success>true</Success>
  <Definition>
    <ReferenceID>S000011</ReferenceID>
    <Name>CustomK.FABRIC</Name>
    <FileName>CustomK.FABRIC.ST3</FileName>
    <DefaultStyle>false</DefaultStyle>
    <Blanks />
  </Definition>
</Response>


Error Response
<Response>
	<Success>false</Success>
	<ErrorCode>MISSING_PARAMETER</ErrorCode>
	<ErrorMessage>Detailed error message</ErrorMessage>
</Response>
Properties
NameTypeDescription
SuccessstringPossible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
Definitionobjectobject with style properties.

See object for more details
ErrorCodestringOnly available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessagestringOnly available if the call failed to execute. This is a detailed message for the error.
Definition
NameTypeDescription
ReferenceIDstringThe unique identifier of the style.
NamestringThe name of the style.
FileNamestringThe file name of the style.
DefaultStylebooleanThis is Melco provided style or not.
Blankslist/objectList of associated blanks

		        

            

		
		

		
	


        
Version: 3.6.277.0