Get List (GetList)

Return the list of fonts / alphabets associated with user account.

Method Url

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

Parameters

Name	Type	Default	Required	Description
Format	string	xml	false	output format. available format's XML,json,jsonp
StartIndex	int	0	false	Starting Index of the Fonts / Alphabet List.
RecordCount	int	1000000	false	Number of records to be returned in the list.
CollectionReferenceID	string		false	Collection ReferenceID if you want to search the fonts associated with specific collection.
Tags	string		false	comma separated list if tags, It will search the fonts based on "end" condition. For example if you passed "embroidery,melco" then it will return the fonts where both tags are associated.
SearchText	string		false	Search text, if you want to search the fonts by some specific text. It will search the text in the name of the font.

Output / Result

XML

JSON

Expected Response
{ "success": "true", "count": 2, "list": [ { "referenceid": "F00054", "name": "Micro Block", "file_name": "Micro Block.ofa", "font_face": "Micro Block", "service": "Embroidery", "tags": ["ABC","ACD"], "collection_list": [], "cache_image":"http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd53.png?user=username" }, { "referenceid": "F00037", "name": "Micro Block New", "file_name": "Micro Block.ofa", "font_face": "Micro Block", "service": "Embroidery", "tags": [], "collection_list": [ { "referenceid": "FC0011" }, { "referenceid": "2" } ], "cache_image":"http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd55.png?user=username" } ] }

Expected Response

{
    "success": "true",
    "count": 2,
    "list": [
        {
            "referenceid": "F00054",
            "name": "Micro Block",
            "file_name": "Micro Block.ofa",
            "font_face": "Micro Block",
            "service": "Embroidery",
            "tags": ["ABC","ACD"],
            "collection_list": [],
			"cache_image":"http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd53.png?user=username"
        },
        {
            "referenceid": "F00037",
            "name": "Micro Block New",
            "file_name": "Micro Block.ofa",
            "font_face": "Micro Block",
            "service": "Embroidery",
            "tags": [],
            "collection_list": [
                {
                    "referenceid": "FC0011"
                },
                {
                    "referenceid": "2"
                }
            ],
			"cache_image":"http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd55.png?user=username"
        }
    ]
}

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 fonts available based on the filters.
list	Array/List	Array / List of Fonts available based on all the input filters. See object for more details

list

Name	Type	Description
referenceid	string	Unique identifier for the font.
name	string	Font / Alphabet name.
file_name	string	Name of the Font / Alphabet File.
service		Embroidery or Printing based on the font/alphabet type.
tags	Array/List	Array / List of Tags associated with this font.
fonts	Array/List	Array / List of Collections referencing this font.
cache_image	string	Image Path of preview image. Default size is 350x80

Expected Response
<Response> <Success>true</Success> <Count>2</Count> <List> <Font> <ReferenceID>F00054</ReferenceID> <Name>Micro Block</Name> <FileName>Micro Block.ofa</FileName> <FontFace>Micro Block</FontFace> <Service>Embroidery</Service> <Tags> <Tag>ABC</Tag> <Tag>ACD</Tag> </Tags> <CollectionList /> <CacheImage>http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd53.png?user=username</CacheImage> </Font> <Font> <ReferenceID>F00035</ReferenceID> <Name>Arial</Name> <FileName>arial.ttf</FileName> <FontFace>Arial</FontFace> <Service>Printing</Service> <Tags /> <CollectionList> <Collection> <ReferenceID>FC0010</ReferenceID> </Collection> </CollectionList> <CacheImage>http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd55.png?user=username</CacheImage> </Font> </List> </Response>

Expected Response

<Response>
  <Success>true</Success>
  <Count>2</Count>
  <List>
    <Font>
      <ReferenceID>F00054</ReferenceID>
      <Name>Micro Block</Name>
      <FileName>Micro Block.ofa</FileName>
      <FontFace>Micro Block</FontFace>
      <Service>Embroidery</Service>
      <Tags>
        <Tag>ABC</Tag>
        <Tag>ACD</Tag>
      </Tags>
      <CollectionList />
	  <CacheImage>http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd53.png?user=username</CacheImage>
    </Font>
    <Font>
      <ReferenceID>F00035</ReferenceID>
      <Name>Arial</Name>
      <FileName>arial.ttf</FileName>
      <FontFace>Arial</FontFace>
      <Service>Printing</Service>
      <Tags />
      <CollectionList>
        <Collection>
          <ReferenceID>FC0010</ReferenceID>
        </Collection>
      </CollectionList>
	  <CacheImage>http://assets2.livedesignerfusion.com/54240db22a9a5394919b8e67ffcc3debd55.png?user=username</CacheImage>
    </Font>
  </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". Return true if successfully executed and return false if failed to execute.
Count	int	Total number of fonts available based on the filters.
List	Array/List	Array / List of Fonts available based on all the input filters. See object for more details

List

Name	Type	Description
ReferenceID	string	Unique identifier for the font.
Name	string	Font / Alphabet name.
FileName	string	Name of the Font / Alphabet File.
Service		Embroidery or Printing based on the font/alphabet type.
Tags	Array/List	Array / List of Tags associated with this font.
Fonts	Array/List	Array / List of Collections referencing this font.
CacheImage	string	Image Path of preview image. Default size is 350x80

Get Font Definition (GetDefinition)

Return the font meta data.

Method Url

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

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Font unique identifier.
Format	string	xml	false	output format (xml.json,jsonp).

Output / Result

XML

JSON

return the object with font meta data.

Expected Response
{ "success": "true", "definition": { "referenceid": "F00050", "name": "Micro Block", "file_name": "Micro Block.ofa", "service": "Embroidery", "font_face": "Micro Block", "tags": [Embroidery, Block], "collections_count": 1, "compositions_count": 5, "readies_count": 0 } }

Expected Response

{
    "success": "true",
    "definition": {
        "referenceid": "F00050",
        "name": "Micro Block",
        "file_name": "Micro Block.ofa",
        "service": "Embroidery",
        "font_face": "Micro Block",
        "tags": [Embroidery, Block],
        "collections_count": 1,
        "compositions_count": 5,
        "readies_count": 0
    }
}

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.
definition	object/node	font object 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.

definition

Name	Type	Description
referenceid	string	Font unique identifier.
name	string	Font name.
file_name	string	Font file name.
service	string	"Embroidery" or "Print" base don font type.
font_face	string	Font Style Name.
tags	Array / Object	Array of font / alphabet tags.
collections_count	int	Number of collections (Font associated with)
compositions_count	int	Number of Compositions (Font associated with)
readies_count	int	Number of Readies (Font associated with)

Expected Response
<Response> <Success>true</Success> <Definition> <ReferenceID>F00050</ReferenceID> <Name>Micro Block</Name> <FileName>Micro Block.ofa</FileName> <Service>Embroidery</Service> <FontFace>Micro Block</FontFace> <Tags> <Tag>Embroidery</Tag> <Tag>Block</Tag> </Tags> <CollectionsCount>1</CollectionsCount> <CompositionsCount>5</CompositionsCount> <ReadiesCount>0</ReadiesCount> </Definition> </Response>

Expected Response

<Response>
  <Success>true</Success>
  <Definition>
    <ReferenceID>F00050</ReferenceID>
    <Name>Micro Block</Name>
    <FileName>Micro Block.ofa</FileName>
    <Service>Embroidery</Service>
    <FontFace>Micro Block</FontFace>
    <Tags>
		<Tag>Embroidery</Tag>
		<Tag>Block</Tag>
	</Tags>
    <CollectionsCount>1</CollectionsCount>
    <CompositionsCount>5</CompositionsCount>
    <ReadiesCount>0</ReadiesCount>
  </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". Return true if successfully executed and return false if failed to execute.
Definition	object/node	font object 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.

Definition

Name	Type	Description
ReferenceID	string	Font unique identifier.
Name	string	Font name.
FileName	string	Font file name.
Service	string	"Embroidery" or "Print" base don font type.
FontFace	string	Font Style Name.
Tags	Array / Object	Array of font / alphabet tags.
CollectionsCount	int	Number of collections (Font associated with)
CompositionsCount	int	Number of Compositions (Font associated with)
ReadiesCount	int	Number of Readies (Font associated with)

Get Image (GetImage)

Return the Font Preview Image. Preview image text is not configureable.

Method Url

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

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Font Unique identifier.
Height	int	400	false	Height of the output image.
Width	int	400	false	Width of the output image.

Output / Result

Return Font Image.

Get Thumbnail Image (GetThumbnail)

Return the font thumbnail image.

Method Url

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

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	required If FileID parameter is not passed. Font unique identifier.
Width	int	100	false	Thumbnail Image size in pixels.
Height	int	100	false	Height of the output image

Output / Result

return thumbnail image (graphics).

Get Font File (GetFile)

Returns the Font file.

Method Url

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

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	A unique identifier, representing the font to download.

Output / Result

returns font file.

Get Tags (GetTags)

Retreive the List of Font/Alphabet tags.

Method Url

https://client.livedesignerfusion.com/{username}/Fonts/GetTags?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 Tags and count of fonts/alphabets referencing this tag.

Expected Response
{ "success" : "true", "count" : 2, "list" : [ { "name" : "Monogram", "count" : 1 }, { "name" : "Holidays", "count" : 1 } ] }

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 tags.
list	Array/List of items	List / Array of Items 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
name	string	Name of the Tag.
count	int	Number of Fonts / Alphabets associated with this tag.

Expected Response
<Response> <Success>true</Success> <Count>2</Count> <List> <Item> <Name>Monogram</Name> <Count>1</Count> </Item> <Item> <Name>Holidays</Name> <Count>1</Count> </Item> </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". Return true if successfully executed and return false if failed to execute.
Count	int	Total number of available tags.
List	Array/List of items	List / Array of Items 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
Name	string	Name of the Tag.
Count	int	Number of Fonts / Alphabets associated with this tag.

Set Font Meta Data (SetMetaData)

update the Font Information / metadata.

Method Url

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

Parameters

Name	Type	Required	Description
ReferenceID	string	true	Font Unique Indetifier.
Name	string	true	Font Name (this will be updated as new Font name).
Tags	string	true	Comma separated list of tags you want to associate with font.

Output / Result

XML

JSON

Update the font metadata information and return the following object.

Expected Response
{ "success":"true" }

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

Properties

Name	Type	Description
success	string	"true" if information updated successfully or "false" if failed.
error_code	string	Only available if there is error in execution.
error_message	string	detailed error message.

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	"true" if information updated successfully or "false" if failed.
ErrorCode	string	Only available if there is error in execution.
ErrorMessage	string	detailed error message.

Upload Font/Alphabet (Upload)

Import the posted file as font/alphabet.

Method Url

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

Parameters

Name	Type	Default	Required	Description
id	string		true	Unique identifier forthe fonts. If passed as blank then It will create automatically new unique identifier.
tags	string		false	Comma seperated List of Tags to be associated with font.
Format	string	xml	false	output format (xml, json,jsonp).

Output / Result

XML

JSON

Upload / Import the posted file into fonts library.

Properties

Name	Type	Description
success	string	"true" if design imported successfully else "false".
error_code	string	Available if execution is failed.
error_message	string	Detailed error message (Available if execution is failed).
referenceid	string	Available only if success=true. Unique identifier for font.
file_name	string	Available only if success=true. font file name.
style_count	int	number of styles in this file. Available only if success=true.

Properties

Name	Type	Description
Success	string	"true" if design imported successfully else "false".
ErrorCode	string	Available if execution is failed.
ErrorMessage	string	Detailed error message (Available if execution is failed).
ReferenceID	string	Available only if success=true. Unique identifier for font.
FileName	string	Available only if success=true. font file name.
StyleCount	int	number of styles in this file. Available only if success=true.

Delete Font (Delete)

it will remove the font if not associated with Compositions / Collections / Readies.

Method Url

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

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Font unique identifier, you want to delete.
Format	string	xml	false	output format (xml,json,jsonp).

Output / Result

XML

JSON

Delete font.

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 executed successfully else false.
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 executed successfully else false.
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 Preview (GetPreview)

Return the Font Preview Image.

Method Url

https://client.livedesignerfusion.com/{username}/Fonts/GetPreview?parameterlist

Parameters

Name	Type	Default	Required	Description
ReferenceID	string		true	Font Unique identifier.
Width	int	50	false	Width of the output image.
Square	bool	true	false	output image will will be square image. If this value is true then height parameter value will be ignored.
text	string	Text	false	Preview Image Text.

Output / Result

Return Font Preview Image.

Get List (GetList)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Get Font Definition (GetDefinition)

Method Url

Parameters

Output / Result XML JSON

Properties

definition

Properties

Definition

Get Image (GetImage)

Method Url

Parameters

Output / Result

Get Thumbnail Image (GetThumbnail)

Method Url

Parameters

Output / Result

Get Font File (GetFile)

Method Url

Parameters

Output / Result

Get Tags (GetTags)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Set Font Meta Data (SetMetaData)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Upload Font/Alphabet (Upload)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Delete Font (Delete)

Method Url

Parameters

Output / Result XML JSON

Properties

Properties

Get Preview (GetPreview)

Method Url

Parameters

Output / Result

Getting Started

General API

JavaScript API

Developer Tools

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON