Get Colors List (GetList)

Return list of colors

Method Url

https://client.livedesignerfusion.com/{username}/Color/GetList?parameters

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		false	Color collection referenceID
Format	string	xml	false	return the result object in this format. Available formts xml,json,jsonp
StartIndex	int	0	false	Start index of the resultset.
RecordCount	int	9999	false	Result set size.

Output / Result

XML

JSON

return list of color collections.

Expected Response
{ "success" : "true", "count" : 2, "list" : [ { "referenceid" : "0082FF00018", "r" : 0, "g" : 130, "b" : 255, "display_name" : ["Light Blue"], "default_name" : "Light Blue", "supplier_code" : "0001", "thread_code" : "8" }, { "referenceid" : "E6AFC8", "r" : 230, "g" : 175, "b" : 200, "display_name" : ["Swarthy Pink"], "default_name" : "Swarthy Pink", "supplier_code" : "", "thread_code" : "" }, ] }

Expected Response

{
    "success" : "true",
    "count" : 2,
    "list" : [
        {
            "referenceid" : "0082FF00018",
            "r" : 0,
            "g" : 130,
            "b" : 255,
            "display_name" : ["Light Blue"],
            "default_name" : "Light Blue",
            "supplier_code" : "0001",
            "thread_code" : "8"
        },
        {
            "referenceid" : "E6AFC8",
            "r" : 230,
            "g" : 175,
            "b" : 200,
            "display_name" : ["Swarthy Pink"],
            "default_name" : "Swarthy Pink",
            "supplier_code" : "",
            "thread_code" : ""
        },
    ]
}

Error Response
{ "success" : "false", "error_code" : "MISSING_PARAMETER", "error_message" : "Detailed error message" }

Properties

Name	Type	Description
success	string	Possible values "true", "false". Return true if successfully executed and return false if failed to execute.
count	int	Total number of available color collections under your account.
list	array/list	List / Array of colors See object for more details
error_code	string	only available if failed to execute. This is error identifier. refer to error code list for more details.
error_message	string	only available if failed to execute. This is detailed message for the error.

list

Name	Type	Description
referenceid	string	Color unique identifier
r	int	Color R value
g	string	Color G value
b	string	Color B value
display_name	string	Color display name
default_name	string	Color default name
supplier_code	string	Color Supplier color. only available for thread colors
thread_code	string	Color thread code. only available for thread colors

Expected Response
<Response> <Success>true</Success> <Count>2</Count> <List> <Color> <ReferenceID>0082FF00018</ReferenceID> <R>0</R> <G>130</G> <B>255</B> <DisplayName>Light Blue</DisplayName> <DefaultName>Light Blue</DefaultName> <SupplierCode>0001</SupplierCode> <ThreadCode>8</ThreadCode> </Color> <Color> <ReferenceID>E6AFC8</ReferenceID> <R>230</R> <G>175</G> <B>200</B> <DisplayName>Swarthy Pink</DisplayName> <DefaultName>Swarthy Pink</DefaultName> <SupplierCode /> <ThreadCode /> </Color> <Color> </Response>

Expected Response

<Response>
	<Success>true</Success>
	<Count>2</Count>
	<List>
		<Color>
			<ReferenceID>0082FF00018</ReferenceID>
			<R>0</R>
			<G>130</G>
			<B>255</B>
			<DisplayName>Light Blue</DisplayName>
			<DefaultName>Light Blue</DefaultName>
			<SupplierCode>0001</SupplierCode>
			<ThreadCode>8</ThreadCode>
		</Color>
		<Color>
			<ReferenceID>E6AFC8</ReferenceID>
			<R>230</R>
			<G>175</G>
			<B>200</B>
			<DisplayName>Swarthy Pink</DisplayName>
			<DefaultName>Swarthy Pink</DefaultName>
			<SupplierCode />
			<ThreadCode />
		</Color>
	<Color>
</Response>

Error Response
<Response> <Success>false</Success> <ErrorCode>MISSING_PARAMETER</ErrorCode> <ErrorMessage>Detailed error message</ErrorMessage> </Response>

Properties

Name	Type	Description
Success	string	Possible values "true", "false". Return true if successfully executed and return false if failed to execute.
Count	int	Total number of available color collections under your account.
List	array/list	List / Array of colors See object for more details
ErrorCode	string	only available if failed to execute. This is error identifier. refer to error code list for more details.
ErrorMessage	string	only available if failed to execute. This is detailed message for the error.

List

Name	Type	Description
ReferenceID	string	Color unique identifier
R	int	Color R value
G	string	Color G value
B	string	Color B value
DisplayName	string	Color display name
DefaultName	string	Color default name
SupplierCode	string	Color Supplier color. only available for thread colors
ThreadCode	string	Color thread code. only available for thread colors

Add new color (Create)

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

Method Url

https://client.livedesignerfusion.com/{username}/Color/Create?parameters

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Color collection referenceID.
R	int		true	Color R value
G	int		true	Color G value
B	int		true	Color B value
Name	string		false	Color display name
SupplierCode	string		false	Thread Supplier Code
ThreadCode	string		true	Thread Code
Format	string	xml	false	output format. Available formats xml,json,jsonp.

Output / Result

XML

JSON

return the result object with the following properties

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

Error Response
{ "success" : "false", "error_code" : "MISSING_PARAMETER", "error_message" : "Detailed error message" }

Properties

Name	Type	Description
success	string	Possible values "true", "false". Return true if successfully executed and return false if failed to execute.
referenceid	string	ReferenceID for the newly created collection.
error_code	string	Only available if failed to execute. This is error identifier. refer to error code list for more details.
error_message	string	Only available if failed to execute. This is detailed message for the error.

Expected Response
<Response> <Success>true</Success> <ReferenceID>00000000003</ReferenceID> </Response>

Error Response
<Response> <Success>false</Success> <ErrorCode>MISSING_PARAMETER</ErrorCode> <ErrorMessage>Detailed error message</ErrorMessage> </Response>

Properties

Name	Type	Description
Success	string	Possible values "true", "false". Return true if successfully executed and return false if failed to execute.
ReferenceID	string	ReferenceID for the newly created collection.
ErrorCode	string	Only available if failed to execute. This is error identifier. refer to error code list for more details.
ErrorMessage	string	Only available if failed to execute. This is detailed message for the error.

Update Color (Update)

update existing color. User must be authentication to perform this activity

Method Url

https://client.livedesignerfusion.com/{username}/Color/Update?parameters

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Color collection referenceID.
ColorReferenceID	string		true	Color referenceID, you want to update.
R	int		true	Color R value
G	int		true	Color G value
B	int		true	Color B value
Name	string		false	Color display name
SupplierCode	string		false	Thread Supplier Code
ThreadCode	string		true	Thread Code
Format	string	xml	false	output format. Available formats xml,json,jsonp.

Output / Result

XML

JSON

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

Name	Type	Description
success	string	Possible values "true", "false". Return true if successfully executed and return false if failed to execute.
error_code	string	Only available if failed to execute. This is error identifier. refer to error code list for more details.
error_message	string	Only 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

Name	Type	Description
Success	string	Possible values "true", "false". Return true if successfully executed and return false if failed to execute.
ErrorCode	string	Only available if failed to execute. This is error identifier. refer to error code list for more details.
ErrorMessage	string	Only available if failed to execute. This is detailed message for the error.

Get Colors List (GetList)

Method Url

Parameters

Output / Result

XML

JSON

Properties

list

Properties

List

Add new color (Create)

Method Url

Parameters

Output / Result

XML

JSON

Properties

Properties

Update Color (Update)

Method Url

Parameters

Output / Result

XML

JSON

Properties

Properties

Getting Started

General API

JavaScript API

Developer Tools

Get Colors List (GetList)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Add new color (Create)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Update Color (Update)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Getting Started

General API

JavaScript API

Developer Tools

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON