Get Design List (GetList)

Get List of Designs

Method Url

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

Parameters

Name	Type	Default	Required	Description
StartIndex	int	0	false	0-based starting index of the designs to be returned. Use this in conjunction with the RecordCount parameter to retrieve sets of designs. For example, call this method with StartIndex=0 and RecordCount=50 to retrieve the first 50 designs. Then, call this method with StartIndex=50 and RecordCount=50 to retrieve the next 50 designs. Then, call this method with StartIndex=100 and RecordCount=50 to retrieve the next 50 designs. And so on.
RecordCount	int	100	false	The number of designs in the retuned list (List Size). Maximum = 1000 designs.
CollectionReferenceID	string		false	Collection ReferenceID. Returns only the designs in the designated collection.
Tags	string		false	Comma separated list of tags. This list will apply a search filter as an "and" condition. For example, if the value of "embroidery,melco" is passed in for this parameter, then only designs having both "embroidery" and "melco" tags will be returned.
SearchText	string		false	This will return designs that have the provided text in the design name.
Methods	string		false	Embelishment Embroidery=1, Print=2. If 1 is passed, then only embroidery designs will be returned. default is all
MinColors	int		false	Only print designs that have at least the provided number of colors will be returned. If this parameter is passed with embroidery(methods) then it will be ignored.
MaxColors	int		false	Only print designs that have the provided number of print colors or less will be returned. If this parameter is passed with embroidery(methods) then it will be ignored.
MinThreads	int		false	Only embroidery designs that have at least the provided number of embroidery colors will be returned. If this parameter is passed with printing(methods) then it will be ignored.
MaxThreads	int		false	Only embroidery designs that have the provided number of embroidery colors or less will be returned.If this parameter is passed with printing(methods) then it will be ignored.
MinStitches	int		false	Only embroidery designs that have at least the provided number of stitches will be returned.If this parameter is passed with printing(methods) then it will be ignored.
MaxStitches	int		false	Only embroidery designs that have the provided number of stitches or less will be returned.If this parameter is passed with printing(methods) then it will be ignored.
MinSize	float		false	The minimum dimension in tenth's of a millimeter (i.e. 254 = 1 inch) for width and height for embroidery designs in the returned design list.
MaxSize	float		false	The maximum dimension in tenth's of a millimeter (i.e. 254 = 1 inch) for width and height for embroidery designs in the returned design list.
EndUserName	string		false	Search designs for specific end user assigned in the design upload api call.
Scope	string	All	false	Search designs for specific scope (Public/1 ,Private/2).
Vendor	string		false	ReferenceID of design providers. Refer GetVendorList api call for details.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

Return the list of designs in the requested format.

Expected Response
{ "success" : "true", "count" : 2, "list" : [ { "referenceid" : "D000175", "name" : "Mustang", "file_name" : "Mustang.ofm", "service" : "Embroidery", "thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/994170a4c65482948508839d0645ec29869.png", "tags" : [ "Animal", "Horse" ], "collections" : [ "DC0015", "DC0007" ], "sort_order" : 0, "scope" :"Public", "vendor" : "" }, { "referenceid" : "D000173", "name" : "Ball", "file_name" : "Ball.ofm", "service" : "Embroidery", "thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/4136053843fa21b4f028fe2e6f648e1fa5c.png", "tags" : [ "Beach", "Ball", "Ocean" ], "collections" : [ "DC0015" ], "sort_order" : 0, "scope" :"Public", "vendor" : "AI" } ] }

Expected Response

{
	"success" : "true",
	"count" : 2,
	"list" : [
		{
			"referenceid" : "D000175",
			"name" : "Mustang",
			"file_name" : "Mustang.ofm",
			"service" : "Embroidery",
			"thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/994170a4c65482948508839d0645ec29869.png",
			"tags" : [
				"Animal",
				"Horse"
			],
			"collections" : [
				"DC0015",
				"DC0007"
			],
			"sort_order" : 0,
			"scope" :"Public",
			"vendor" : ""
		},
		{
			"referenceid" : "D000173",
			"name" : "Ball",
			"file_name" : "Ball.ofm",
			"service" : "Embroidery",
			"thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/4136053843fa21b4f028fe2e6f648e1fa5c.png",
			"tags" : [
					"Beach",
					"Ball",
					"Ocean"
				],
			"collections" : [
					"DC0015"
				],
			"sort_order" : 0,
			"scope" :"Public",
			"vendor" : "AI"
		}
	]
}

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
count	int	The total number of designs that were returned, based on the applied filters. (This is required to implement paging, etc.)
list	array/list	Array / List of designs. See object for more details
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

list

Name	Type	Description
referenceid	string	This is the unique identifier for the design. It is required to access any information about this specific design.
name	string	The name of the design. By default, this will be the file name of the uploaded design without the extension. For example, if you uploaded a design file named "disney.ofm", then the name will be "disney".
file_name	string	The file name of the design. For example, "disney.ofm", or "alligator.eps".
service	string	The name of the service (Embroidery or Print).
thumbnail_cache_100x100	string	If a cached 100x100 thumbnail file exists for this design, that url will be returned here. If this field is empty and you wish to retrieve the design thumbnail, or if you with a thumbnail of a different size, please utilize the Designs/GetThumbnail API call.
tags	array/xmlnode	Array / List of tags associated with the design.
collections	array/xmlnode	Array / List of Collections with which the design is associated.
scope	string	Design scope (Public or Private)
vendor	string	Design Provider name i.e. AI, Dakota etc.

Expected Response
<Response> <Success>true</Success> <Count>2</Count> <List> <Design> <ReferenceID>D000175</ReferenceID> <Name>Mustang</Name> <FileName>Mustang.ofm</FileName> <Service>Embroidery</Service> <ThumbnailCache100x100>http://assets.livedesignerfusion.com/994170a4c65482948508839d0645ec29869.png</ThumbnailCacheFileName> <Tags> <Tag>Animal</Tag> <Tag>Horse</Tag> </Tags> <Collections> <Collection>DC0015</Collection> <Collection>DC0007</Collection> </Collections> <SortOrder>0</SortOrder> <Scope>Public</Scope> <Vendor><Vendor> </Design> <Design> <ReferenceID>D000173</ReferenceID> <Name>Ball</Name> <FileName>Ball.ofm</FileName> <Service>Embroidery</Service> <ThumbnailCache100x100>http://assets.livedesignerfusion.com/994170a4c65482948508839d0645ec29869.png</ThumbnailCacheFileName> <Tags> <Tag>Beach</Tag> <Tag>Ball</Tag> <Tag>Ocean</Tag> </Tags> <Collections> <Collection>DC0015</Collection> </Collections> <SortOrder>0</SortOrder> <Scope>Public</Scope> <Vendor>AI<Vendor> </Design> </List> </Response>

Expected Response

<Response>
	<Success>true</Success>
	<Count>2</Count>
	<List>
		<Design>
			<ReferenceID>D000175</ReferenceID>
			<Name>Mustang</Name>
			<FileName>Mustang.ofm</FileName>
			<Service>Embroidery</Service>
			<ThumbnailCache100x100>http://assets.livedesignerfusion.com/994170a4c65482948508839d0645ec29869.png</ThumbnailCacheFileName>
			<Tags>
				<Tag>Animal</Tag>
				<Tag>Horse</Tag>
			</Tags>
			<Collections>
				<Collection>DC0015</Collection>
				<Collection>DC0007</Collection>
			</Collections>
			<SortOrder>0</SortOrder>
			<Scope>Public</Scope>
			<Vendor><Vendor>
		</Design>
		<Design>
			<ReferenceID>D000173</ReferenceID>
			<Name>Ball</Name>
			<FileName>Ball.ofm</FileName>
			<Service>Embroidery</Service>
			<ThumbnailCache100x100>http://assets.livedesignerfusion.com/994170a4c65482948508839d0645ec29869.png</ThumbnailCacheFileName>
			<Tags>
				<Tag>Beach</Tag>
				<Tag>Ball</Tag>
				<Tag>Ocean</Tag>
			</Tags>
			<Collections>
				<Collection>DC0015</Collection>
			</Collections>
			<SortOrder>0</SortOrder>
			<Scope>Public</Scope>
			<Vendor>AI<Vendor>
		</Design>
	</List>
</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". Will return true if the call successfully executed and will return false if the call failed to execute.
Count	int	The total number of designs that were returned, based on the applied filters. (This is required to implement paging, etc.)
List	array/list	Array / List of designs. See object for more details
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

List

Name	Type	Description
ReferenceID	string	This is the unique identifier for the design. It is required to access any information about this specific design.
Name	string	The name of the design. By default, this will be the file name of the uploaded design without the extension. For example, if you uploaded a design file named "disney.ofm", then the name will be "disney".
FileName	string	The file name of the design. For example, "disney.ofm", or "alligator.eps".
Service	string	The name of the service (Embroidery or Print).
ThumbnailCache100X100	string	If a cached 100x100 thumbnail file exists for this design, that url will be returned here. If this field is empty and you wish to retrieve the design thumbnail, or if you with a thumbnail of a different size, please utilize the Designs/GetThumbnail API call.
Tags	array/xmlnode	Array / List of tags associated with the design.
Collections	array/xmlnode	Array / List of Collections with which the design is associated.
Scope	string	Design scope (Public or Private)
Vendor	string	Design Provider name i.e. AI, Dakota etc.

Get Design Definition (GetDefinition)

Returns metadata for a given design.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetDefinition?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	The unique identifier of the design for which you wish to receive metadata.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

Returns the requested design's metadata.

Expected Response
{ "success" : "true", "definition" : { "referenceid" : "D000138", "name" : "Airmen", "file_name" : "Airmen.ofm", "stitches" : 6673, "colors" : 4, "height" : "1.7 in.", "width" : "5.9 in.", "tags" : [ "Airplane", "Pilot", "Fly" ], "collections" : 2, "compositions" : 1, "readies" : 2, "design_type" : "Embroidery", "thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/905a15dcfd53fdf4726a4f975da7c3b6e32.png", "views" : 5, "downloads" : 2, "istemplate" :false, "scope" :"Private", "vendor" : "AI", "end_username":"" } }

Expected Response

{
	"success" : "true",
	"definition" : {
		"referenceid" : "D000138",
		"name" : "Airmen",
		"file_name" : "Airmen.ofm",
		"stitches" : 6673,
		"colors" : 4,
		"height" : "1.7 in.",
		"width" : "5.9 in.",
		"tags" : [
			"Airplane",
			"Pilot",
			"Fly"
			],
		"collections" : 2,
		"compositions" : 1,
		"readies" : 2,
		"design_type" : "Embroidery",
		"thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/905a15dcfd53fdf4726a4f975da7c3b6e32.png",
		"views" : 5,
		"downloads" : 2,
		"istemplate" :false,
		"scope" :"Private",
		"vendor" : "AI",
		"end_username":""
	}
}

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
definition	object	object with design properties. See object for more details
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

definition

Name	Type	Description
referenceid	string	The unique identifier of the design.
name	string	The name of the design.
file_name	string	The file name of the design.
stitches	int	The number of stitches in the design. This will be 0 (zero) for print designs.
colors	int	The number of colors in the design.
height	string
width	string	The width of the design.
tags	Array / Object	An array containing all of the tags associated with this design.
collections	int	The number of collections with which this design is associated.
compositions	int	The number of compositions with which this design is associated.
readies	int	The number of readies with which this design is associated.
design_type	string	The type of design (Embroidery or Vector).
thumbnail_cache_100x100	string	If a cached 100x100 thumbnail file exists for this design, that url will be returned here. If this field is empty and you wish to retrieve the design thumbnail, or if you with a thumbnail of a different size, please utilize the Designs/GetThumbnail API call.
views	int	View count, how many time this design is viewed.
downloads	int	Download count, how many time this design is downloaded.
istemplate	boolean	Boolean value, true for design templates and false for generic designs.
scope	string	Design scope (Public or Private)
vendor	string	Design Provider name i.e. AI, Dakota etc.

Expected Response
<Response> <Success>true</Success> <Definition> <ReferenceID>D000138</ReferenceID> <Name>Airmen</Name> <FileName>Airmen.ofm</FileName> <Stitches>6673</Stitches> <Colors>4</Colors> <Height>1.7 in.</Height> <Width>5.9 in.</Width> <Tags> <Tag>Airplane</Tag> <Tag>Pilot</Tag> <Tag>Fly</Tag> </Tags> <Collections>2</Collections> <Compositions>1</Compositions> <Readies>2</Readies> <DesignType>Embroidery</DesignType> <ThumbnailCache100X100>http://assets.livedesignerfusion.com/905a15dcfd53fdf4726a4f975da7c3b6e32.png</ThumbnailCache100X100> <Views>5</Views> <Downloads>2</Downloads> <IsTemplate>false</IsTemplate> <Scope>Private</Scope> <Vendor>AI</Vendor> <EndUserName>AI</EndUserName> </Definition> </Response>

Expected Response

<Response>
	<Success>true</Success>
	<Definition>
		<ReferenceID>D000138</ReferenceID>
		<Name>Airmen</Name>
		<FileName>Airmen.ofm</FileName>
		<Stitches>6673</Stitches>
		<Colors>4</Colors>
		<Height>1.7 in.</Height>
		<Width>5.9 in.</Width>
		<Tags>
			<Tag>Airplane</Tag>
			<Tag>Pilot</Tag>
			<Tag>Fly</Tag>
		</Tags>
		<Collections>2</Collections>
		<Compositions>1</Compositions>
		<Readies>2</Readies>
		<DesignType>Embroidery</DesignType>
		<ThumbnailCache100X100>http://assets.livedesignerfusion.com/905a15dcfd53fdf4726a4f975da7c3b6e32.png</ThumbnailCache100X100>
		<Views>5</Views>
		<Downloads>2</Downloads>
		<IsTemplate>false</IsTemplate>
		<Scope>Private</Scope>
		<Vendor>AI</Vendor>
		<EndUserName>AI</EndUserName>
	</Definition>
</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". Will return true if the call successfully executed and will return false if the call failed to execute.
Definition	object	object with design properties. See object for more details
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

Definition

Name	Type	Description
ReferenceID	string	The unique identifier of the design.
Name	string	The name of the design.
FileName	string	The file name of the design.
Stitches	int	The number of stitches in the design. This will be 0 (zero) for print designs.
Colors	int	The number of colors in the design.
Height	string
Width	string	The width of the design.
Tags	Array / Object	An array containing all of the tags associated with this design.
Collections	int	The number of collections with which this design is associated.
Compositions	int	The number of compositions with which this design is associated.
Readies	int	The number of readies with which this design is associated.
DesignType	string	The type of design (Embroidery or Vector).
ThumbnailCache100X100	string	If a cached 100x100 thumbnail file exists for this design, that url will be returned here. If this field is empty and you wish to retrieve the design thumbnail, or if you with a thumbnail of a different size, please utilize the Designs/GetThumbnail API call.
Views	int	View count, how many time this design is viewed.
Downloads	int	Download count, how many time this design is downloaded.
IsTemplate	boolean	Boolean value, true for design templates and false for generic designs.
Scope	string	Design scope (Public or Private)
Vendor	string	Design Provider name i.e. AI, Dakota etc.

Get Design Image (GetImage)

Returns an image of the selected design.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetImage?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	The unique identifier of the design for which you want the image.
DPI	int	96	false	Your desired image resolution.

Output / Result

Returns an image of the selected design.

Get Thumbnail Image (GetThumbnail)

Return the design thumbnail image.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetThumbnail?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	The unique identifier, representing the Design for which you want the thumbnail.
Width	int	100	false	Thumbnail Image width in pixels.
Square	boolean	true	false	If true, the output image will be square.

Output / Result

Returns a thumbnail image (graphics).

Get Design File (GetFile)

Returns the Design file.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetFile?parameterlist

Parameters

Name

Type

Default

Required

Description

ReferenceID

string

true

Unique identifier for the design you want to download.

FileName

string

false

Output file name with extension. Value of the this parameter determines the output type, if you want to download the ofm file, pass the value of this parameter as [FileName].ofm refer the detailed table for supported file formats See more details

Code Snippets

Download

C#

using System;
using System.Net;
using System.IO;
using System.Xml;

namespace Melco.Examples
{
    public class Designs
    {
        public static void GetFile()
        {
            string url = "";
            WebRequest webRequest = WebRequest.Create(url);
            webRequest.Method = "GET";
            WebResponse webResponse = webRequest.GetResponse();
            Stream responseStream = webResponse.GetResponseStream();
            if (webResponse.ContentType.ToLower().StartsWith("text/xml;"))
            {
                //logic to handle the error here

                //get the error details
                StreamReader reader = new StreamReader(responseStream);
                string resStr= reader.ReadToEnd();
                reader.Close();
                XmlDocument xmlDOC = new XmlDocument();
                xmlDOC.LoadXml(resStr);

                string error = xmlDOC.SelectSingleNode("/Response/ErrorCode").InnerText;
                string errorMessage = xmlDOC.SelectSingleNode("/Response/ErrorMessage").InnerText;
            }
            else
            {
                MemoryStream memoryStream = new MemoryStream();
                int count = 0;
                byte[] result = null;
                byte[] fileBuffer = new byte[webResponse.ContentLength];
                do
                {
                    count = responseStream.Read(fileBuffer, 0, fileBuffer.Length);
                    memoryStream.Write(fileBuffer, 0, count);
                    if (count == 0){
                        break;
                    }
                }
                while (true);
                result = memoryStream.ToArray();
                System.IO.File.WriteAllBytes(@"C:\Examples\GetFile.ofm", result);
                memoryStream.Close();
                responseStream.Close();
            }
            responseStream.Close();
            webResponse.Close();
        }
    }
}

Output / Result

Returns the design file.

Get Design Meta Data (GetMetaData)

Return the design metadata.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetMetaData?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	The unique identifier of the design for which you wish to receive metadata.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

Returns the object with the design metadata.

Expected Response
{ "success" : "true", "design_data" : { "referenceid" : "D000135", "stitches" : 12050, "design_colors" : [ { "id" : "C0", "color_r" : 236, "color_g" : 244, "color_b" : 251, "thread_code" : "621", "thread_name" : "", "manufacturer" : "ARC Poly", "name" : "Wings" }, { "id" : "C1", "color_r" : 192, "color_g" : 203, "color_b" : 198, "thread_code" : "10", "thread_name" : "", "manufacturer" : "ARC Poly", "name" : "Body" } ], "letterings" : [ { "id" : "L0", "text" : "MILLBORO VOLUNTEER", "alphabet" : "OESCO BLOCK CP", "height" : 78.884, "colors" : [ { "id" : "C2", "color_r" : 59, "color_g" : 60, "color_b" : 59, "thread_code" : "621", "thread_name" : "", "manufacturer" : "ARC Poly", "name" : "Border" } ] }, { "id" : "L1", "text" : "FIRE ASSN", "alphabet" : "OESCO BLOCK CP", "height" : 80.772, "colors" : [ { "id" : "C3", "color_r" : 59, "color_g" : 60, "color_b" : 59, "thread_code" : "621", "thread_name" : "", "manufacturer" : "ARC Poly", "name" : "Text Color" } ] } ] } }

Expected Response

{
	"success" : "true",
	"design_data" : {
			"referenceid" : "D000135",
			"stitches" : 12050,
			"design_colors" : [
				{
					"id" : "C0",
					"color_r" : 236,
					"color_g" : 244,
					"color_b" : 251,
					"thread_code" : "621",
					"thread_name" : "",
					"manufacturer" : "ARC Poly",
					"name" : "Wings"
				},
				{
					"id" : "C1",
					"color_r" : 192,
					"color_g" : 203,
					"color_b" : 198,
					"thread_code" : "10",
					"thread_name" : "",
					"manufacturer" : "ARC Poly",
					"name" : "Body"
				}
			],
			"letterings" : [
				{
					"id" : "L0",
					"text" : "MILLBORO VOLUNTEER",
					"alphabet" : "OESCO BLOCK CP",
					"height" : 78.884,
					"colors" : [
						{
							"id" : "C2",
							"color_r" : 59,
							"color_g" : 60,
							"color_b" : 59,
							"thread_code" : "621",
							"thread_name" : "",
							"manufacturer" : "ARC Poly",
							"name" : "Border"
						}
					]
				},
				{
					"id" : "L1",
					"text" : "FIRE ASSN",
					"alphabet" : "OESCO BLOCK CP",
					"height" : 80.772,
					"colors" : [
						{
							"id" : "C3",
							"color_r" : 59,
							"color_g" : 60,
							"color_b" : 59,
							"thread_code" : "621",
							"thread_name" : "",
							"manufacturer" : "ARC Poly",
							"name" : "Text Color"
						}
					]
				}
			]
		}
}

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

Properties

Name	Type	Description
referenceid	string	Design unique identifier.
stitches	int	The number of stitches in the design. This will be 0 (zero) for print designs.
design_colors	object/xml element	List of colors available in this design. This is just designs colors - lettering color will not be included in this list. See object for more details
lettering	object /element	List of Lettering objects in the design. See object for more details

design_colors

Name	Type	Description
id	string	Element ID. Unique identifier - required to modify the design by API.
color_r	int	R value of the color.
color_g	int	G value of the color.
color_b	int	B value of the color.
thread_code	string	Thread Code. This is applicable for embroidery designs only.
thread_name	string	Thread Name. This is applicable for embroidery designs only.
manufacturer	string	Thread Manufacturer or Supplier. This is applicable for embroidery designs only i.e. ARC Poly

lettering

Name	Type	Description
id	string	Lettering ElementID. Unique identifier - required to modify the design by API.
text	string	Element Text.
alphabet	string	Alphabet Name.
height	decimal	Lettering Height in CM.
colors	object/xml element	List of Colors available in this lettering.

Expected Response
<Response> <Success>true</Success> <DesignData> <ReferenceID>D000135</ReferenceID> <Stitches>12050</Stitches> <DesignColors> <DesignColor> <Id>C0</Id> <ColorR>236</ColorR> <ColorG>244</ColorG> <ColorB>251</ColorB> <ThreadCode>621</ThreadCode> <ThreadName></ThreadName> <Manufacturer>ARC Poly</Manufacturer> <Name>Wings</Name> </DesignColor> <DesignColor> <Id>C1</Id> <ColorR>192</ColorR> <ColorG>203</ColorG> <ColorB>198</ColorB> <ThreadCode>622</ThreadCode> <ThreadName></ThreadName> <Manufacturer>ARC Poly</Manufacturer> <Name>Body</Name> </DesignColor> </DesignColors> <Letterings> <Lettering> <Id>L0</Id> <Text>MILLBORO VOLUNTEER</Text> <Alphabet>OESCO BLOCK CP</Alphabet> <Height>78.884</Height> <Colors> <Color> <Id>C2</Id> <ColorR>59</ColorR> <ColorG>60</ColorG> <ColorB>59</ColorB> <ThreadCode>621</ThreadCode> <ThreadName></ThreadName> <Manufacturer>ARC Poly</Manufacturer> <Name>Border</Name> </Color> </Colors> </Lettering> <Lettering> <Id>L1</Id> <Text>FIRE ASSN</Text> <Alphabet>OESCO BLOCK CP</Alphabet> <Height>80.772</Height> <Colors> <Color> <Id>C3</Id> <ColorR>59</ColorR> <ColorG>60</ColorG> <ColorB>59</ColorB> <ThreadCode>10</ThreadCode> <ThreadName></ThreadName> <Manufacturer>ARC Poly</Manufacturer> <Name>TextColor</Name> </Color> </Colors> </Lettering> </Letterings> </DesignData> </Response>

Expected Response

<Response>
	<Success>true</Success>
	<DesignData>
		<ReferenceID>D000135</ReferenceID>
		<Stitches>12050</Stitches>
		<DesignColors>
			<DesignColor>
				<Id>C0</Id>
				<ColorR>236</ColorR>
				<ColorG>244</ColorG>
				<ColorB>251</ColorB>
				<ThreadCode>621</ThreadCode>
				<ThreadName></ThreadName>
				<Manufacturer>ARC Poly</Manufacturer>
				<Name>Wings</Name>
			</DesignColor>
			<DesignColor>
				<Id>C1</Id>
				<ColorR>192</ColorR>
				<ColorG>203</ColorG>
				<ColorB>198</ColorB>
				<ThreadCode>622</ThreadCode>
				<ThreadName></ThreadName>
				<Manufacturer>ARC Poly</Manufacturer>
				<Name>Body</Name>
			</DesignColor>
		</DesignColors>
		<Letterings>
			<Lettering>
				<Id>L0</Id>
				<Text>MILLBORO VOLUNTEER</Text>
				<Alphabet>OESCO BLOCK CP</Alphabet>
				<Height>78.884</Height>
				<Colors>
					<Color>
						<Id>C2</Id>
						<ColorR>59</ColorR>
						<ColorG>60</ColorG>
						<ColorB>59</ColorB>
						<ThreadCode>621</ThreadCode>
						<ThreadName></ThreadName>
						<Manufacturer>ARC Poly</Manufacturer>
						<Name>Border</Name>
					</Color>
				</Colors>
			</Lettering>
			<Lettering>
				<Id>L1</Id>
				<Text>FIRE ASSN</Text>
				<Alphabet>OESCO BLOCK CP</Alphabet>
				<Height>80.772</Height>
				<Colors>
					<Color>
						<Id>C3</Id>
						<ColorR>59</ColorR>
						<ColorG>60</ColorG>
						<ColorB>59</ColorB>
						<ThreadCode>10</ThreadCode>
						<ThreadName></ThreadName>
						<Manufacturer>ARC Poly</Manufacturer>
						<Name>TextColor</Name>
					</Color>
				</Colors>
			</Lettering>
		</Letterings>
	</DesignData>
</Response>

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

Properties

Name	Type	Description
ReferenceID	string	Design unique identifier.
Stitches	int	The number of stitches in the design. This will be 0 (zero) for print designs.
DesignColors	object/xml element	List of colors available in this design. This is just designs colors - lettering color will not be included in this list. See object for more details
Lettering	object /element	List of Lettering objects in the design. See object for more details

DesignColors

Name	Type	Description
ID	string	Element ID. Unique identifier - required to modify the design by API.
ColorR	int	R value of the color.
ColorG	int	G value of the color.
ColorB	int	B value of the color.
ThreadCode	string	Thread Code. This is applicable for embroidery designs only.
ThreadName	string	Thread Name. This is applicable for embroidery designs only.
Manufacturer	string	Thread Manufacturer or Supplier. This is applicable for embroidery designs only i.e. ARC Poly

Lettering

Name	Type	Description
ID	string	Lettering ElementID. Unique identifier - required to modify the design by API.
Text	string	Element Text.
Alphabet	string	Alphabet Name.
Height	decimal	Lettering Height in CM.
Colors	object/xml element	List of Colors available in this lettering.

Get Design Tags (GetTags)

Returns a list of design tags.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetTags?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		false	To retrieve tags associated with a specific design, pass ReferenceID of the design here.
CollectionReferenceID	string		false	To retrieve tags associated with a design collection, pass ReferenceID of the design collection here.
Methods	string		false	Filter Tags for embroidery or print. Pass "embroidery" or 1 to filter tags for embroidery designs and "print" or 2 to filter designs for print.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

Returns the list of tags in requested format.

Expected Response
{ "success" : "true", "count" : 2, "list" : [ { "name" : "Embroidery", "count" : 5 }, { "name" : "Ball", "count":2 } ] }

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
count	int	Total number of available tags.
list	object	Array / List of the requested tags. See object for more details
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

list

Name	Type	Description
name	string	The name of the tag
count	string	The number of the designs with which this tag is associated.

Expected Response
<Response> <Success>true</Success> <List> <Tag> <Name>Embroidery</Name> <Count>5</Count> </Tag> <Tag> <Name>Ball</Name> <Count>2</Count> </Tag> </List> </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". Will return true if the call successfully executed and will return false if the call failed to execute.
Count	int	Total number of available tags.
List	object	Array / List of the requested tags. See object for more details
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

List

Name	Type	Description
Name	string	The name of the tag
Count	string	The number of the designs with which this tag is associated.

Get Service/ Method Info (GetMethodInfo)

Returns a list of services/methods and a count of designs accosciated with each service/method.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetMethodInfo?parameterlist

Parameters

Name	Type	Default	Required	Description
CollectionReferenceID	string		false	To retrieve the service/method information associated with a specific design collection, pass the ReferenceID of the design collection here.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

Returns information about services/methods.

Expected Response
{ "success" : "true", "list" : [ { "referenceid" : 1, "name" : "Embroidery", "count" : 142 }, { "referenceid" : 2, "name" : "Printing", "count" : 29 } ] }

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
list	object	Array / List of Services/Methods. See object for more details
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

list

Name	Type	Description
referenceid	int	The unique identifier of the service/method.
name	string	The name of the service/method.
count	int	The number of designs associated with this service/method.

Expected Response
<Response> <Success>true</Success> <List> <Method> <ReferenceID>1</ReferenceID> <Name>Embroidery</Name> <Count>142</Count> </Method> <Method> <ReferenceID>2</ReferenceID> <Name>Printing</Name> <Count>29</Count> </Method> </List> </Response>

Expected Response

<Response>
	<Success>true</Success>
	<List>
		<Method>
			<ReferenceID>1</ReferenceID>
			<Name>Embroidery</Name>
			<Count>142</Count>
		</Method>
		<Method>
			<ReferenceID>2</ReferenceID>
			<Name>Printing</Name>
			<Count>29</Count>
		</Method>
	</List>
</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". Will return true if the call successfully executed and will return false if the call failed to execute.
List	object	Array / List of Services/Methods. See object for more details
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

List

Name	Type	Description
ReferenceID	int	The unique identifier of the service/method.
Name	string	The name of the service/method.
Count	int	The number of designs associated with this service/method.

Set Design Meta Data (SetMetaData)

Update the design information / metadata.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/SetMetaData?parameterlist

Parameters

Name	Type	Required	Description
ReferenceID	string	false	The unique identifier of the design for which you wish to set metadata.
Name	string	true	This will update the design name to the value provided.
Tags	string	true	Comma separated list of tags you wish to associate with the design.
Scope	string	false	Design Scope (Public, Private).
Vendor	string	false	Design provider Referenceid. Refer GetVendorList api call for details.

Output / Result

XML

JSON

Update the design metadata information and return a success indicator or error information.

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". Will return true if the call successfully executed and will return false if the call failed to execute.
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only 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

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

Upload Design (Upload)

Import the posted file as a design.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/Upload?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		false	Design unique identifier. This allows you to set your own value for your design's DesignID / ReferenceID. This value must be unique or the upload will fail. This value will be trimmed(extra spaces will be removed) before processing
Tags	string		false	Comma seperated list of tags to be associated with the design.
EndUserName	string		false	Assign Design to specific user to filter it in other api calls. This needs to be unique identifier for data consistency i.e. UserName filed from your system (if it's non editable) or UserID field etc.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp
DesignType	string	Design	false	Type of the design (Design or Template)
Scope	string	private	false	Design Scope (Public, Private).
Vendor	string		false	Design provider Referenceid. Refer GetVendorList api call for details.

Output / Result

XML

JSON

Upload / Import the posted design into the design catalog.

Expected Response

{
	"success" : "true",
	"definition" : [
		"success" : "true",
		"referenceid" : "D000138",
		"name" : "Airmen",
		"file_name" : "Airmen.ofm",
		"stitches" : 6673,
		"colors" : 4,
		"height" : "1.7 in.",
		"width" : "5.9 in.",
		"tags" : [
			"Airplane",
			"Pilot",
			"Fly"
			],
		"collections" : 0,
		"compositions" : 0,
		"readies" : 0,
		"design_type" : "Embroidery",
		"thumbnail_cache_100x100" : "http://assets.livedesignerfusion.com/905a15dcfd53fdf4726a4f975da7c3b6e32.png",
		"scope" :"Private",
		"vendor" : "AI"
	]
}

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
design	string	The design object (with all the properties available in the GetDefinition call) will be returned only if the upload was successful.
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

Properties

Name	Type	Description
Success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
Design	string	The design object (with all the properties available in the GetDefinition call) will be returned only if the upload was successful.
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

Delete Design (Delete)

This call will remove the selected design if that design is not associated with any Compositions, Collections, or Readies.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/Delete?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		false	Design unique identifier. The ReferenceID of the design you wish to delete.
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

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, used).1. true: the design was successfully deleted.2. false: the deletion failed due to some system error. 3. used: the design is associated with a collection, composition, or ready so it cannot be deleted.
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only 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

Name	Type	Description
Success	string	Possible values (true, false, used).1. true: the design was successfully deleted.2. false: the deletion failed due to some system error. 3. used: the design is associated with a collection, composition, or ready so it cannot be deleted.
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

Get Auto Suggest (GetAutoSuggest)

Get List of Design Names and Tags for auto sugest functionality.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetAutoSuggest?parameterlist

Parameters

Name	Type	Default	Required	Description
RecordCount	int	100	false	Record Count of Result Set. Maximum = 1000.
SearchText	string		false	Filter the resultset by search text i.e. "a" will return all the data contains "a" in name or tags.

Output / Result

XML

JSON

Return the resultset of auto suggest by applying parameters.

Expected Response
{ "success": "true", "count": 5, "list": [ " Joker", "Animal", "Mascot", "Melco", "Wings" ] }

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
count	int	The total number of records available for the resultset.
list	array/list	Array / List of auto suggest.
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

Expected Response
<Response> <Success>true</Success> <Count>5</Count> <List> <Row>Joker</Row> <Row>Animal</Row> <Row>Mascot</Row> <Row>Melco</Row> <Row>Wings</Row> </List> </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". Will return true if the call successfully executed and will return false if the call failed to execute.
Count	int	The total number of records available for the resultset.
List	array/list	Array / List of auto suggest.
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

Get Design Stitch Player (GetStitchPlayer)

Render flash based stitch player. It's always suggested to render in iframe or new tab/window.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetStitchPlayer?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Unique identifier for the design,you want to render stitch player. This will work only for embroidery designs..
Height	int	400	false	Stitch Player Height.
Width	int	400	false	Stitch Player Width.
Auto	boolean	false	false	Automatically start player on load.
Speed	int	75	false	player rendering speed.

Output / Result

render stitch player.

Set Design Stats (SetStats)

Set Design Stats (Rating, views etc)

Method Url

https://client.livedesignerfusion.com/{username}/Designs/SetStats?parameterlist

Parameters

Name	Type	Required	Description
ReferenceID	string	true	Unique identifier for the design
EndUserName	string	true	EndUserName (Unique String) to associate stats. If this value is not passed or passed as blnak string, we will try to associate with Request IP.
UserTags	string	false	Custom End User Tags.
Rating	int	false	Design Rating, value range is 1-5
Hidden	boolean	false	Design Status, allowed values (0,1,true,false). This will not hide the design from admin tool.
Viewed	boolean	false	Increment the view count, allowed values (1,true)
Downloaded		false	increment the download count, allowed values (1,true)

Output / Result

XML

JSON

Return design and end user stats.

Expected Response

{
    "success": "true",
    "design_stats": {
        "rating": 0,
        "views": 215,
        "downloads": 131
    },
    "user_design_stats": {
        "rating": 0,
        "views": 4,
        "last_viewed": "6/5/2012 10:21:09 PM",
        "hidden": "false",
        "downloads": 0,
        "last_downloaded": ""
    }
}

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
referenceid	string	This is the unique identifier for the design. It is required to access any information about this specific design.
design_stats	object/node	object or node with design stats properties. These proprties are specific to enduser See object for more details
user_design_stats	object/node	object or node with user stats properties. See object for more details
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

design_stats

Name	Type	Description
rating	string	Design global rating.
downloads	string	Global design downloads.
viewes	string	Gobal design view count.

user_design_stats

Name	Type	Description
rating	string	design rating by current user(endusername).
views	string	design views count by current user(endusername).
last_viewed	string	design last viewed date time by current user(endusername).
hidden	string	design hidden status for current user(endusername).
downloads	string	design downloads count by current user(endusername).
last_downloaded	string	design last downloaded date time by current user(endusername).

Expected Response

<Response>
  <Success>true</Success>
  <DesignStats>
    <Rating>0</Rating>
    <Views>216</Views>
    <Downloads>131</Downloads>
  </DesignStats>
  <UserDesignStats>
    <Rating>0</Rating>
    <Views>5</Views>
    <LastViewed>6/5/2012 10:21:41 PM</LastViewed>
    <Hidden>false</Hidden>
    <Downloads>0</Downloads>
    <LastDownloaded></LastDownloaded>
  </UserDesignStats>
</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". Will return true if the call successfully executed and will return false if the call failed to execute.
ReferenceID	string	This is the unique identifier for the design. It is required to access any information about this specific design.
DesignStats	object/node	object or node with design stats properties. These proprties are specific to enduser See object for more details
UserDesignStats	object/node	object or node with user stats properties. See object for more details
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

DesignStats

Name	Type	Description
Rating	string	Design global rating.
Downloads	string	Global design downloads.
Viewes	string	Gobal design view count.

UserDesignStats

Name	Type	Description
Rating	string	design rating by current user(endusername).
Views	string	design views count by current user(endusername).
LastViewed	string	design last viewed date time by current user(endusername).
Hidden	string	design hidden status for current user(endusername).
Downloads	string	design downloads count by current user(endusername).
LastDownloaded	string	design last downloaded date time by current user(endusername).

Get Design Files as zip (GetFiles)

Returns archive of designs.

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetFiles?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	comma seprated list of design refrence id's, you want to download.
FileName	string	designs.zip	false	Output file name.

Output / Result

Returns zip file of requested designs.

Get Vendor List (GetVendorList)

Get List of Design Vendors or Providers

Method Url

https://client.livedesignerfusion.com/{username}/Designs/GetVendorList?parameterlist

Parameters

Name	Type	Default	Required	Description
Format	string	xml	false	Output format. Available format's: XML, json, jsonp

Output / Result

XML

JSON

Return the list of design vendors or providers.

Expected Response
{ "success": "true", "count": 1, "list": [ { "referenceid": "V1", "name": "AI" } ] }

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

Properties

Name	Type	Description
success	string	Possible values "true", "false". Will return true if the call successfully executed and will return false if the call failed to execute.
count	int	The total number of design providers.
list	array/list	Array / List of design providers. See object for more details
error_code	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
error_message	string	Only available if the call failed to execute. This is a detailed message for the error.

list

Name	Type	Description
referenceid	string	This is the unique identifier for the design provider. This is required to search any information about provider or search by provider.
name	string	Design Provider Name.

Expected Response
<Response> <Success>true</Success> <Count>1</Count> <List> <Designvendor> <ReferenceID>V1</ReferenceID> <Name>AI</Name> </Designvendor> </List> </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". Will return true if the call successfully executed and will return false if the call failed to execute.
Count	int	The total number of design providers.
List	array/list	Array / List of design providers. See object for more details
ErrorCode	string	Only available if the call failed to execute. This is the error identifier. Please refer to error code list for more details.
ErrorMessage	string	Only available if the call failed to execute. This is a detailed message for the error.

List

Name	Type	Description
ReferenceID	string	This is the unique identifier for the design provider. This is required to search any information about provider or search by provider.
Name	string	Design Provider Name.

Get Design List (GetList)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Get Design Definition (GetDefinition)

Method Url

Parameters

Output / Result XML JSON

Properties

definition

Properties

Definition

Get Design Image (GetImage)

Method Url

Parameters

Output / Result

Get Thumbnail Image (GetThumbnail)

Method Url

Parameters

Output / Result

Get Design File (GetFile)

Method Url

Parameters

Code Snippets

Output / Result

Get Design Meta Data (GetMetaData)

Method Url

Parameters

Output / Result XML JSON

Properties

design_colors

lettering

Properties

DesignColors

Lettering

Get Design Tags (GetTags)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Get Service/ Method Info (GetMethodInfo)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Set Design Meta Data (SetMetaData)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Upload Design (Upload)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Delete Design (Delete)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Get Auto Suggest (GetAutoSuggest)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Get Design Stitch Player (GetStitchPlayer)

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON