Get List of Blanks (GetList)

Returns List of blanks for this user

Method Url

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

Parameters

Name	Type	Default	Required	Description
{username}{username}	string		true	replace {username} with your fusion username in the method url before sending the request.
StartIndex	int	0	false	start index of resultset
RecordCount	int	100	false	total resultset size. Max allowed value is 200
Tags	string		false	List of tags to filter resultset
SearchText	string		false	SearchText to filter resultset
Format	string	xml	false	output format. available format's XML,json,jsonp

Output / Result

XML

JSON

Returns List of blanks

Expected Response
{ "success": "true", "count": 2, "list": [ { "referenceid": 739, "name": "polo", "tags": [ "shirt" ], "image_100x100": "http://assets.livedesignerfusion.com/3551771bb4b1d9842ef946a75517fa17e57.png", "auto_save": false }, { "referenceid": 710, "name": "Checker 1700", "tags": [], "image_100x100": "http://assets.livedesignerfusion.com/361c9039f6c8c8a4c1495e8b5d84387fa81.png", "auto_save": false } ] }

Expected Response

{
    "success": "true",
    "count": 2,
    "list": [
        {
            "referenceid": 739,
            "name": "polo",
            "tags": [
                "shirt"
            ],
            "image_100x100": "http://assets.livedesignerfusion.com/3551771bb4b1d9842ef946a75517fa17e57.png",
            "auto_save": false
        },
        {
            "referenceid": 710,
            "name": "Checker 1700",
            "tags": [],
            "image_100x100": "http://assets.livedesignerfusion.com/361c9039f6c8c8a4c1495e8b5d84387fa81.png",
            "auto_save": false
        }
    ]
}

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	Number of total blanks available for the user.
list	array/list	Array / List of blanks. See object for more details

list

Name	Type	Description
referenceid	string	unique identifier for blank.
name	string	Name of the blank defined during blank creation process.
tags	Array of strings	List of tags associated with blank.
image_100x100	string	if image is cached this is the path of thumbnail image.
auto_save	boolean	Boolean value representing the state of blank. If it's in process of editing or not.

Expected Response
<Response> <Success>true</Success> <Count>2</Count> <List> <Blank> <ReferenceID>739</ReferenceID> <Name>polo</Name> <Tags /> <Image100X100>http://assets.livedesignerfusion.com/3551771bb4b1d9842ef946a75517fa17e57.png</Image100X100> <AutoSave>false</AutoSave> </Blank> <Blank> <ReferenceID>710</ReferenceID> <Name>Checker 1700</Name> <Tags /> <Image100X100>http://assets.livedesignerfusion.com/361c9039f6c8c8a4c1495e8b5d84387fa81.png</Image100X100> <AutoSave>false</AutoSave> </Blank> </List> </Response>

Expected Response

<Response>
  <Success>true</Success>
  <Count>2</Count>
  <List>
    <Blank>
      <ReferenceID>739</ReferenceID>
      <Name>polo</Name>
      <Tags />
      <Image100X100>http://assets.livedesignerfusion.com/3551771bb4b1d9842ef946a75517fa17e57.png</Image100X100>
      <AutoSave>false</AutoSave>
    </Blank>
    <Blank>
      <ReferenceID>710</ReferenceID>
      <Name>Checker 1700</Name>
      <Tags />
      <Image100X100>http://assets.livedesignerfusion.com/361c9039f6c8c8a4c1495e8b5d84387fa81.png</Image100X100>
      <AutoSave>false</AutoSave>
    </Blank>
  </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	Number of total blanks available for the user.
List	array/list	Array / List of blanks. See object for more details

List

Name	Type	Description
ReferenceID	string	unique identifier for blank.
Name	string	Name of the blank defined during blank creation process.
Tags	Array of strings	List of tags associated with blank.
Image100X100	string	if image is cached this is the path of thumbnail image.
AutoSave	boolean	Boolean value representing the state of blank. If it's in process of editing or not.

Get Blank Definition (GetDefinition)

Return the blank meta data.

Method Url

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

Parameters

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

Output / Result

XML

JSON

Return blank object.

Expected Response
{ "success": "true", "definition": { "referenceid": 740, "name": "PNG", "default_image_definition": { "image_fileid": 911, "imageid": 7845, "file_name": "10185537.png", "image_url": "", "view_name": "", "color_name": "", "tags": [], "canvas_width": 470, "canvas_height": 470, "original_width": 2362, "original_height": 2362, "image": "http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png" }, "tags": [ "towel" ], "images": [ { "image_fileid": 911, "imageid": 7845, "file_name": "10185537.png", "image_url": "", "view_name": "", "color_name": "", "tags": [], "canvas_width": 470, "canvas_height": 470, "original_width": 2362, "original_height": 2362, "image": "http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png" } ], "image":"http://assets.livedesignerfusion.com/314e03c5690190148a5866c955dc7c18e1e.png" } }

Expected Response

{
    "success": "true",
    "definition": {
        "referenceid": 740,
        "name": "PNG",
        "default_image_definition": {
            "image_fileid": 911,
            "imageid": 7845,
            "file_name": "10185537.png",
            "image_url": "",
            "view_name": "",
            "color_name": "",
            "tags": [],
            "canvas_width": 470,
            "canvas_height": 470,
            "original_width": 2362,
            "original_height": 2362,
            "image": "http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png"
        },
        "tags": [
            "towel"
        ],
        "images": [
            {
                "image_fileid": 911,
                "imageid": 7845,
                "file_name": "10185537.png",
                "image_url": "",
                "view_name": "",
                "color_name": "",
                "tags": [],
                "canvas_width": 470,
                "canvas_height": 470,
                "original_width": 2362,
                "original_height": 2362,
                "image": "http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png"
            }
        ],
		"image":"http://assets.livedesignerfusion.com/314e03c5690190148a5866c955dc7c18e1e.png"
    }
}

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	array/list	blank object. See object for more details

definition

Name	Type	Description
referenceid	string	This is unique identifier for blank and required to access the any information about this blank.
name	string	Blank name
tags	array/xmlnode	Array / List of tags associated with the blank.
default_image_definition	array/list	blank default image object. See object for more details
image	array/list	preview image url
images	array/list	List/Array of images (structure macthes with default_image_definition)

default_image_definition

Name	Type	Description
image_fileid	string	Unique identifier for blank image
file_name	string	file name
image_url	string	http url if image is brwosed from the internet.
view_name	string	Image view name. i.e front or back
color_name	string	Image color name. i.e front or back
tags	array/xmlnode	Array / List of tags associated with the image.
canvas_width	int	Canvas width, defined in blank creation process.
canvas_height	int	Canvas height, defined in blank creation process.
original_width	int	actual width of uploaded image.
original_height	int	actual height of uploaded image.

Expected Response
<Response> <Success>true</Success> <Definition> <ReferenceID>740</ReferenceID> <Name>PNG</Name> <DefaultImageDefinition> <ImageFileID>911</ImageFileid> <ImageID>7845</Imageid> <FileName>10185537.png</FileName> <ImageUrl></ImageUrl> <ViewName></ViewName> <ColorName></ColorName> <Tags /> <CanvasWidth>470</CanvasWidth> <CanvasHeight>470</CanvasHeight> <OriginalWidth>2362</OriginalWidth> <OriginalHeight>2362</OriginalHeight> <Image>http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png</Image> </DefaultImageDefinition> <Tags> <Tag>towel</Tag> </Tags> <Images> <Image> <ImageFileID>911</ImageFileid> <ImageID>7845</Imageid> <FileName>10185537.png</FileName> <ImageUrl></ImageUrl> <ViewName></ViewName> <ColorName></ColorName> <Tags /> <CanvasWidth>470</CanvasWidth> <CanvasHeight>470</CanvasHeight> <OriginalWidth>2362</OriginalWidth> <OriginalHeight>2362</OriginalHeight> <Image>http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png</Image> </Image> </Images> <Image>http://assets.livedesignerfusion.com/314e03c5690190148a5866c955dc7c18e1e.png</Image> </Definition> </Response>

Expected Response

<Response>
  <Success>true</Success>
  <Definition>
    <ReferenceID>740</ReferenceID>
    <Name>PNG</Name>
    <DefaultImageDefinition>
      <ImageFileID>911</ImageFileid>
      <ImageID>7845</Imageid>
      <FileName>10185537.png</FileName>
      <ImageUrl></ImageUrl>
      <ViewName></ViewName>
      <ColorName></ColorName>
      <Tags />
      <CanvasWidth>470</CanvasWidth>
      <CanvasHeight>470</CanvasHeight>
      <OriginalWidth>2362</OriginalWidth>
      <OriginalHeight>2362</OriginalHeight>
      <Image>http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png</Image>
    </DefaultImageDefinition>
    <Tags>
      <Tag>towel</Tag>
    </Tags>
    <Images>
      <Image>
        <ImageFileID>911</ImageFileid>
        <ImageID>7845</Imageid>
        <FileName>10185537.png</FileName>
        <ImageUrl></ImageUrl>
        <ViewName></ViewName>
        <ColorName></ColorName>
        <Tags />
        <CanvasWidth>470</CanvasWidth>
        <CanvasHeight>470</CanvasHeight>
        <OriginalWidth>2362</OriginalWidth>
        <OriginalHeight>2362</OriginalHeight>
        <Image>http://assets.livedesignerfusion.com/452120063d339fd41e6b27b50cc435e888f.png</Image>
      </Image>
    </Images>
	<Image>http://assets.livedesignerfusion.com/314e03c5690190148a5866c955dc7c18e1e.png</Image>
  </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	array/list	blank object. See object for more details

Definition

Name	Type	Description
ReferenceID	string	This is unique identifier for blank and required to access the any information about this blank.
Name	string	Blank name
Tags	array/xmlnode	Array / List of tags associated with the blank.
DefaultImageDefinition	array/list	blank default image object. See object for more details
Image	array/list	preview image url
Images	array/list	List/Array of images (structure macthes with default_image_definition)

DefaultImageDefinition

Name	Type	Description
ImageFileid	string	Unique identifier for blank image
FileName	string	file name
ImageUrl	string	http url if image is brwosed from the internet.
ViewName	string	Image view name. i.e front or back
ColorName	string	Image color name. i.e front or back
Tags	array/xmlnode	Array / List of tags associated with the image.
CanvasWidth	int	Canvas width, defined in blank creation process.
CanvasHeight	int	Canvas height, defined in blank creation process.
OriginalWidth	int	actual width of uploaded image.
OriginalHeight	int	actual height of uploaded image.

Get Blank Image (GetImage)

Returns an image of blank.

Method Url

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

Parameters

Name	Type	Default	Required	Description
ImageFileID	string		true	The unique identifier of the blank image.
CustParams	JSON object		false	Customization object (JSON).

Output / Result

Returns an image of the blank.

Get Blank Tags (GetTags)

Returns a list of blank tags.

Method Url

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

Parameters

Name	Type	Default	Required	Description
RecordCount	int	50	false	Retrict the max resultset size to this value.
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": "shirt", "count": 1 }, { "name": "towel", "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". Will return true if the call successfully executed and will return false if the call failed to execute.
count	int	tag count.
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 blanks,where this tag is associated.

Expected Response
<Response> <Success>true</Success> <Count>2</Count> <List> <Tag> <Name>shirt</Name> <Count>1</Count> </Tag> <Tag> <Name>towel</Name> <Count>1</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	tag count.
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 blanks,where this tag is associated.

Get List of Blanks (GetList)

Method Url

Parameters

Output / Result

XML

JSON

Properties

list

Properties

List

Get Blank Definition (GetDefinition)

Method Url

Parameters

Output / Result

XML

JSON

Properties

definition

default_image_definition

Properties

Definition

DefaultImageDefinition

Get Blank Image (GetImage)

Method Url

Parameters

Output / Result

Get Blank Tags (GetTags)

Method Url

Parameters

Output / Result

XML

JSON

Properties

list

Properties

List

Getting Started

General API

JavaScript API

Developer Tools

Get List of Blanks (GetList)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Get Blank Definition (GetDefinition)

Method Url

Parameters

Output / Result XML JSON

Properties

definition

default_image_definition

Properties

Definition

DefaultImageDefinition

Get Blank Image (GetImage)

Method Url

Parameters

Output / Result

Get Blank Tags (GetTags)

Method Url

Parameters

Output / Result XML JSON

Properties

list

Properties

List

Getting Started

General API

JavaScript API

Developer Tools

Output / Result

XML

JSON

Output / Result

XML

JSON

Output / Result

XML

JSON