Get List of Tokens/Sessions (GetList)
Returns a list of Tokens/Sessions. It will return a maximum of 1000 records for each api call.Method Url
https://client.livedesignerfusion.com/{username}/Token/GetListParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | Replace {username} with your fusion username in the method url before sending the request. | |
| Status | string | false | Status Filter for the result set (Saved, Dropped, Live) | |
| StartDate | DateTime | 30 days old | false | Start date of date range filter. |
| EndDate | DateTime | Today's Date | false | End date of date range filter. |
| UTCOffset | double | 0 | false | UTC Time offset. This is not required if the start date and end date is in UTC format. |
| StartIndex | int | 0 | false | Record StartIndex of the resultset. |
| RecordCount | int | 200 | false | Max resultset size. Max allowed value is 200. |
| P.[Custom Parameter Name].[CustomParameterName] | string | false | Filter the result set by a custom parameter. These custom parameters only exist if they were set using the SetParams API. See Token/SetParams for more details. | |
| Format | string | xml | false | Output format. Available format's: XML, json, jsonp |
Output / Result
| Expected Response |
|---|
{
"success" : true,
"count" : 1,
"list" : [
{
"personalization_token" : "bae43ace2dbc4383acbfedb29b8c3b52",
"ready_name" : "Tote Bag",
"ready_token" : "READY-3157",
"created_on" : "2011-11-14T20:02:09.5",
"last_updated" : "2011-11-14T20:02:10.083",
"duration" : 43,
"status" : "Saved",
"sub_status" : ""
}
]
} |
| Error Response |
|---|
{
"success" : "false",
"error_code" : "MISSING_PARAMETER",
"error_message" : "Detailed error message"
} |
Properties
| Name | Type | Description |
|---|---|---|
| success | string | Possible values "true", "false". Returns true if successfully executed and returns false if failed to execute. |
| count | int | Number of total Tokens/Sessions for the current filter. |
| list | array/list | Array / List of Tokens. See object for more details |
list
| Name | Type | Description |
|---|---|---|
| personalization_token | string | Unique Identifier for Token/Session. |
| ready_name | string | Ready Name |
| ready_token | string | Ready Unique identifier. |
| created_on | DateTime | Token Creation Time (UTC DateTime) |
| last_updated | DateTime | Last activity Time(UTC DateTime) |
| duration | int | Duration of Session (Seconds) |
| status | string | Token Statuc (Saved, Dropped, Live) |
| sub_status | string | Token Sub Status (User Cancelled, Timed Out) |
| Expected Response |
|---|
<Response> <Success>true</Success> <Count>1</Count> <List> <Token> <PersonalizationToken>bae43ace2dbc4383acbfedb29b8c3b52</PersonalizationToken> <ReadyName>Tote Bag</ReadyName> <ReadyToken>READY-3157<ReadyToken> <CreatedOn>2011-11-14T20:02:09.5</CreatedOn> <LastUpdated>2011-11-14T20:02:10.083</LastUpdated> <Duration>43</Duration> <Status>Saved</Status> <SubStatus /> </Token> </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". Returns true if successfully executed and returns false if failed to execute. |
| Count | int | Number of total Tokens/Sessions for the current filter. |
| List | array/list | Array / List of Tokens. See object for more details |
List
| Name | Type | Description |
|---|---|---|
| PersonalizationToken | string | Unique Identifier for Token/Session. |
| ReadyName | string | Ready Name |
| ReadyToken | string | Ready Unique identifier. |
| CreatedOn | DateTime | Token Creation Time (UTC DateTime) |
| LastUpdated | DateTime | Last activity Time(UTC DateTime) |
| Duration | int | Duration of Session (Seconds) |
| Status | string | Token Statuc (Saved, Dropped, Live) |
| SubStatus | string | Token Sub Status (User Cancelled, Timed Out) |
Get Token Definition (GetDefinition)
Returns metata for a given Token/Session.
Get Token Definition (GetDefinition)
Method Url
https://client.livedesignerfusion.com/{username}/Token/GetDefinitionParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | Replace {username} with your fusion username in the method url before sending the request. | |
| PersonalizationToken | string | true | The Personalization Token. Generated and returned by the CompletePersonalization method in the JavaScript API. | |
| UTCOffset | double | 0 | false | UTC Time offset. This is not required if the start date and end date is in UTC format. |
| Format | string | xml | false | Output format. Available format's: XML, json, jsonp |
Output / Result
| Expected Response |
|---|
//example 1 (compositions only)
{
"success": "true",
"definition": {
"personalization_token": "3f1393d16d4a4882a3fe51d02f0955cf",
"ready_name": "",
"ready_token": "READY-1565",
"created_on": "/Date(1365801756017)/",
"last_updated": "/Date(1365801758903)/",
"duration": 2,
"status": "Saved",
"sub_status": "",
"custom_parameter_list": [
{
"parameter_key": "FullName",
"parameter_value": "John Doe"
},
{
"parameter_key": "EmailAddress",
"parameter_value": "john.doe@melco.com"
}
],
"elements": [
{
"type": "G",
"height": 78.2,
"width": 90.1,
"referenceid": "C002398",
"elements": [
{
"type": "L",
"serviceid": 1,
"elementid": 19420,
"element_name": "LeftChest_Name",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "Left",
"stitches": 1224,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 79.7,
"height": 27.7,
"visible": 0
},
{
"type": "D",
"referenceid": "D000338",
"serviceid": 1,
"elementid": 19421,
"element_name": "Design1",
"design_name": "HEART",
"file_name": "HEART.ofm",
"stitches": 1623,
"colors": [
{
"type": "e",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 241,
"g": 255,
"b": 82,
"manufacturer": "ARC Poly",
"thread_name": "",
"thread_code": "21"
},
{
"type": "e",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 207,
"g": 76,
"b": 63,
"manufacturer": "ARC Poly",
"thread_name": "",
"thread_code": "3016"
}
],
"width": 90.1,
"height": 78.2,
"visible": 0
}
],
"name": "LeftChest"
},
{
"type": "G",
"height": 78.2,
"width": 100.4,
"referenceid": "C002399",
"elements": [
{
"type": "L",
"serviceid": 1,
"elementid": 19418,
"element_name": "RightChest_Name",
"alphabet_name": "OLDE ENGLISH",
"file_name": "OLDE ENGLISH.OFA",
"text": "Ishwar",
"stitches": 1870,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 222,
"g": 0,
"b": 0,
"manufacturer": "",
"thread_name": "",
"thread_code": ""
}
],
"width": 100.4,
"height": 30.8,
"visible": 1
},
{
"type": "D",
"referenceid": "D000338",
"serviceid": 1,
"elementid": 19419,
"element_name": "Design1",
"design_name": "HEART",
"file_name": "HEART.ofm",
"stitches": 1623,
"colors": [
{
"type": "e",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 241,
"g": 255,
"b": 82,
"manufacturer": "ARC Poly",
"thread_name": "",
"thread_code": "21"
},
{
"type": "e",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 207,
"g": 76,
"b": 63,
"manufacturer": "ARC Poly",
"thread_name": "",
"thread_code": "3016"
}
],
"width": 90.1,
"height": 78.2,
"visible": 1
}
],
"name": "RightChest"
}
]
}
}
//example 2 if elements dropped on ready directly
{
"success": "true",
"definition": {
"personalization_token": "c255e874040747c18bd1a62c6c3f5b42",
"ready_name": "",
"ready_token": "READY-1543",
"created_on": "/Date(1364255032303)/",
"last_updated": "/Date(1364255036283)/",
"duration": 4,
"status": "Saved",
"sub_status": "",
"custom_parameter_list": [],
"elements": [
{
"type": "L",
"serviceid": 1,
"elementid": 18685,
"element_name": "1",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "1",
"stitches": 144,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 9.6,
"height": 24.8,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18686,
"element_name": "2",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "2",
"stitches": 343,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 19.5,
"height": 25.6,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18687,
"element_name": "3",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "3",
"stitches": 433,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 20.7,
"height": 25.3,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18688,
"element_name": "4",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "4",
"stitches": 283,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 17.3,
"height": 24.7,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18689,
"element_name": "5",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "5",
"stitches": 401,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 21.5,
"height": 25.4,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18690,
"element_name": "6",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "6",
"stitches": 340,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 16.4,
"height": 25.1,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18691,
"element_name": "7",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "7",
"stitches": 299,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 20,
"height": 25.3,
"visible": -1
},
{
"type": "L",
"serviceid": 1,
"elementid": 18692,
"element_name": "8",
"alphabet_name": "Marker",
"file_name": "Marker.OFA",
"text": "8",
"stitches": 529,
"colors": [
{
"type": "",
"height_mm": 0,
"width_mm": 0,
"name": "",
"r": 0,
"g": 130,
"b": 255,
"manufacturer": "CSD",
"thread_name": "",
"thread_code": "8"
}
],
"width": 23.3,
"height": 24.8,
"visible": -1
}
]
}
}
|
| Error Response |
|---|
{
"success" : "false",
"error_code" : "MISSING_PARAMETER",
"error_message" : "Detailed error message"
} |
Properties
| Name | Type | Description |
|---|---|---|
| success | string | Possible values "true", "false". Returns true if successfully executed and returns false if failed to execute. |
| definition | object | Token definition object See object for more details |
definition
| Name | Type | Description |
|---|---|---|
| personalization_token | string | Unique Identifier for Token/Session. |
| ready_name | string | Ready Name |
| ready_token | string | Ready Unique identifier. |
| created_on | DateTime | Token Creation Time by requested offset. |
| last_updated | DateTime | Last activity Time by requested offset |
| duration | int | Duration of Session (Seconds) |
| status | string | Token Statuc (Saved, Dropped, Live) |
| sub_status | string | Token Sub Status (User Cancelled, Timed Out) |
| elements | array/list | List/Array of personalized elements on the Product/Blank. This will be recursive object for composition i.e. if type is other than G
then object will contain all the element properties but if the element type is G (Composition) then object will contain composition
properties and will contain array of all the elements
See object for more details |
| custom_parameter_list | array/list | Array / List of any custom parameters associated with each token. These custom parameters only exist if they were set using the SetParams API. See Token/SetParams for more details. See object for more details |
elements
| Name | Type | Description |
|---|---|---|
| type | string | Element Type L, D, G (L=Lettering, D=Design, G=Group of Elements). |
| referenceid | string | Unique Identifier for group. This element will be only available for group type elements |
| elements | object array | Only available for 'G' type elements. Each object in the array supports all the properties and methods available for each element type (Design, Lettering). |
| serviceid | int | Embellishment / Service ID (1 = Embroidery, 2 = Printing). |
| elementid | int | The unique identifier for the element. |
| element_name | string | Element Name defined during the element creation process. |
| design_name | string | The design name (available only for design elements). |
| alphabet_name | string | The selected alphabet/font name, for example, Block, Arial (available only for lettering type elements). |
| file_name | string | The file name of the selected alphabet/font/design. For example, Block.ofa, Arial.ttf, disney.ofm or football.eps. |
| text | string | The text entetred by the user. The default text will be returned if the text input is hidden or if the text is not changed by the user (available for only lettering type elements). |
| stitches | int | The number of embroidery stitches. 0 will be returned for print text and designs. |
| width | float | The element width in millimeters. This will be in pixels for graphic designs (i.e. .png, .jpeg). This is available for designs only. |
| height | float | The element height in millimeters. This will be in pixels for graphic designs (i.e. .png, .jpeg). This is available for designs only. |
| visible | int | Returns element visibility overrides by JavaScript API, it returns following values 0 false 1 true -1 No change inherited from ready |
| colors | object | List of Colors in the Lettering/Design object See object for more details |
colors
| Name | Type | Description |
|---|---|---|
| name | string | The display name of the color. |
| manufacturer | string | The name of the thread manufacturer. Blank string for print colors. |
| thread_code | string | The code or thread number of the embroidery thread. Blank string for print colors. |
| r | int | Color R value. |
| g | int | Color G value. |
| b | int | Color B value. |
| type | string | The type of element layer. This is only available for embroidery designs. Possible values: a = applique, e = embroidery, s = sequin. |
| height_mm | float | If the type attribute is "a", this will contain the height of the applique layer in millimeters. Otherwise, this will return 0. Available only for embroidery designs. |
| width_mm | float | If the type attribute is "a", this will contain the width of the applique layer in millimeters. Otherwise, this will return 0. Available only for embroidery designs. |
custom_parameter_list
| Name | Type | Description |
|---|---|---|
| parameter_key | string | The key (or name) of the parameter. |
| parameter_value | string | The value of the parameter. |
| Expected Response |
|---|
<!-- example 1 (compositions) -->
<Response>
<Success>true</Success>
<Definition>
<PersonalizationToken>3f1393d16d4a4882a3fe51d02f0955cf</PersonalizationToken>
<ReadyName></ReadyName>
<ReadyToken>READY-1565</ReadyToken>
<CreatedOn>2013-04-12T15:22:36.017</CreatedOn>
<LastUpdated>2013-04-12T15:22:38.903</LastUpdated>
<Duration>2</Duration>
<Status>Saved</Status>
<SubStatus></SubStatus>
<CustomParameterList />
<Elements>
<Element>
<Type>G</Type>
<Height>78.2</Height>
<Width>90.1</Width>
<ReferenceID>C002398</ReferenceID>
<Elements>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>19420</ElementID>
<ElementName>LeftChest_Name</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>Left</Text>
<Stitches>1224</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>79.700000</Width>
<Height>27.700000</Height>
<Visible>0</Visible>
</Element>
<Element>
<Type>D</Type>
<ReferenceID>D000338</ReferenceID>
<ServiceID>1</ServiceID>
<ElementID>19421</ElementID>
<ElementName>Design1</ElementName>
<DesignName>HEART</DesignName>
<FileName>HEART.ofm</FileName>
<Stitches>1623</Stitches>
<Colors>
<Color>
<Name></Name>
<R>241</R>
<G>255</G>
<B>82</B>
<Manufacturer>ARC Poly</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>21</ThreadCode>
</Color>
<Color>
<Name></Name>
<R>207</R>
<G>76</G>
<B>63</B>
<Manufacturer>ARC Poly</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>3016</ThreadCode>
</Color>
</Colors>
<Width>90.10</Width>
<Height>78.20</Height>
<Visible>0</Visible>
</Element>
</Elements>
<Name>LeftChest</Name>
</Element>
<Element>
<Type>G</Type>
<Height>78.2</Height>
<Width>100.4</Width>
<ReferenceID>C002399</ReferenceID>
<Elements>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>19418</ElementID>
<ElementName>RightChest_Name</ElementName>
<AlphabetName>OLDE ENGLISH</AlphabetName>
<FileName>OLDE ENGLISH.OFA</FileName>
<Text>Ishwar</Text>
<Stitches>1870</Stitches>
<Colors>
<Color>
<Name></Name>
<R>222</R>
<G>0</G>
<B>0</B>
<Manufacturer></Manufacturer>
<ThreadName></ThreadName>
<ThreadCode></ThreadCode>
</Color>
</Colors>
<Width>100.400000</Width>
<Height>30.800000</Height>
<Visible>1</Visible>
</Element>
<Element>
<Type>D</Type>
<ReferenceID>D000338</ReferenceID>
<ServiceID>1</ServiceID>
<ElementID>19419</ElementID>
<ElementName>Design1</ElementName>
<DesignName>HEART</DesignName>
<FileName>HEART.ofm</FileName>
<Stitches>1623</Stitches>
<Colors>
<Color>
<Name></Name>
<R>241</R>
<G>255</G>
<B>82</B>
<Manufacturer>ARC Poly</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>21</ThreadCode>
</Color>
<Color>
<Name></Name>
<R>207</R>
<G>76</G>
<B>63</B>
<Manufacturer>ARC Poly</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>3016</ThreadCode>
</Color>
</Colors>
<Width>90.10</Width>
<Height>78.20</Height>
<Visible>1</Visible>
</Element>
</Elements>
<Name>RightChest</Name>
</Element>
</Elements>
</Definition>
</Response>
<!-- example 2 (if elements dropped on ready directly) -->
<Response>
<Success>true</Success>
<Definition>
<PersonalizationToken>c255e874040747c18bd1a62c6c3f5b42</PersonalizationToken>
<ReadyName></ReadyName>
<ReadyToken>READY-1543</ReadyToken>
<CreatedOn>2013-03-25T17:43:52.303</CreatedOn>
<LastUpdated>2013-03-25T17:43:56.283</LastUpdated>
<Duration>4</Duration>
<Status>Saved</Status>
<SubStatus></SubStatus>
<CustomParameterList />
<Elements>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18685</ElementID>
<ElementName>1</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>1</Text>
<Stitches>144</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>9.600000</Width>
<Height>24.800000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18686</ElementID>
<ElementName>2</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>2</Text>
<Stitches>343</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>19.500000</Width>
<Height>25.600000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18687</ElementID>
<ElementName>3</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>3</Text>
<Stitches>433</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>20.700000</Width>
<Height>25.300000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18688</ElementID>
<ElementName>4</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>4</Text>
<Stitches>283</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>17.300000</Width>
<Height>24.700000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18689</ElementID>
<ElementName>5</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>5</Text>
<Stitches>401</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>21.500000</Width>
<Height>25.400000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18690</ElementID>
<ElementName>6</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>6</Text>
<Stitches>340</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>16.400000</Width>
<Height>25.100000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18691</ElementID>
<ElementName>7</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>7</Text>
<Stitches>299</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>20.000000</Width>
<Height>25.300000</Height>
<Visible>-1</Visible>
</Element>
<Element>
<Type>L</Type>
<ServiceID>1</ServiceID>
<ElementID>18692</ElementID>
<ElementName>8</ElementName>
<AlphabetName>Marker</AlphabetName>
<FileName>Marker.OFA</FileName>
<Text>8</Text>
<Stitches>529</Stitches>
<Colors>
<Color>
<Name></Name>
<R>0</R>
<G>130</G>
<B>255</B>
<Manufacturer>CSD</Manufacturer>
<ThreadName></ThreadName>
<ThreadCode>8</ThreadCode>
</Color>
</Colors>
<Width>23.300000</Width>
<Height>24.800000</Height>
<Visible>-1</Visible>
</Element>
</Elements>
</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". Returns true if successfully executed and returns false if failed to execute. |
| Definition | object | Token definition object See object for more details |
Definition
| Name | Type | Description |
|---|---|---|
| PersonalizationToken | string | Unique Identifier for Token/Session. |
| ReadyName | string | Ready Name |
| ReadyToken | string | Ready Unique identifier. |
| CreatedOn | DateTime | Token Creation Time by requested offset. |
| LastUpdated | DateTime | Last activity Time by requested offset |
| Duration | int | Duration of Session (Seconds) |
| Status | string | Token Statuc (Saved, Dropped, Live) |
| SubStatus | string | Token Sub Status (User Cancelled, Timed Out) |
| Elements | array/list | List/Array of personalized elements on the Product/Blank. This will be recursive object for composition i.e. if type is other than G
then object will contain all the element properties but if the element type is G (Composition) then object will contain composition
properties and will contain array of all the elements
See object for more details |
| CustomParameterList | array/list | Array / List of any custom parameters associated with each token. These custom parameters only exist if they were set using the SetParams API. See Token/SetParams for more details. See object for more details |
Elements
| Name | Type | Description |
|---|---|---|
| Type | string | Element Type L, D, G (L=Lettering, D=Design, G=Group of Elements). |
| ReferenceID | string | Unique Identifier for group. This element will be only available for group type elements |
| Elements | object array | Only available for 'G' type elements. Each object in the array supports all the properties and methods available for each element type (Design, Lettering). |
| ServiceID | int | Embellishment / Service ID (1 = Embroidery, 2 = Printing). |
| ElementID | int | The unique identifier for the element. |
| ElementName | string | Element Name defined during the element creation process. |
| DesignName | string | The design name (available only for design elements). |
| AlphabetName | string | The selected alphabet/font name, for example, Block, Arial (available only for lettering type elements). |
| FileName | string | The file name of the selected alphabet/font/design. For example, Block.ofa, Arial.ttf, disney.ofm or football.eps. |
| Text | string | The text entetred by the user. The default text will be returned if the text input is hidden or if the text is not changed by the user (available for only lettering type elements). |
| Stitches | int | The number of embroidery stitches. 0 will be returned for print text and designs. |
| Width | float | The element width in millimeters. This will be in pixels for graphic designs (i.e. .png, .jpeg). This is available for designs only. |
| Height | float | The element height in millimeters. This will be in pixels for graphic designs (i.e. .png, .jpeg). This is available for designs only. |
| Visible | int | Returns element visibility overrides by JavaScript API, it returns following values 0 false 1 true -1 No change inherited from ready |
| Colors | object | List of Colors in the Lettering/Design object See object for more details |
Colors
| Name | Type | Description |
|---|---|---|
| Name | string | The display name of the color. |
| Manufacturer | string | The name of the thread manufacturer. Blank string for print colors. |
| ThreadCode | string | The code or thread number of the embroidery thread. Blank string for print colors. |
| R | int | Color R value. |
| G | int | Color G value. |
| B | int | Color B value. |
| Type | string | The type of element layer. This is only available for embroidery designs. Possible values: a = applique, e = embroidery, s = sequin. |
| HeightMm | float | If the type attribute is "a", this will contain the height of the applique layer in millimeters. Otherwise, this will return 0. Available only for embroidery designs. |
| WidthMm | float | If the type attribute is "a", this will contain the width of the applique layer in millimeters. Otherwise, this will return 0. Available only for embroidery designs. |
CustomParameterList
| Name | Type | Description |
|---|---|---|
| ParameterKey | string | The key (or name) of the parameter. |
| ParameterValue | string | The value of the parameter. |
Set Extra token infomation (SetParams)
associate extra information with token. if you execute this method multiple times then it will remove parameters associated previously and will support only 10 parameters at the max.
Set Extra token infomation (SetParams)
Method Url
https://client.livedesignerfusion.com/{username}/Token/SetParamsParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | replace {username} with your fusion username in the method url before sending the request. | |
| Token | string | true | Personalization Token. | |
| P.{ParameterName}.{ParameterName} | string | false | parameter's list. For example if you want to associate your UserID with token pass P.UserID={value} |
Output / Result
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. |
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. |
Set Token/Tokens Property (SetProperties)
Set Token/Tokens properties after personalization.
Set Token/Tokens Property (SetProperties)
Method Url
https://client.livedesignerfusion.com/{username}/Token/SetPropertiesParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | replace {username} with your fusion username in the method url before sending the request. | |
| Property | string | true |
Property you want to set.Available properties 1. Personalizer |
|
| PrevIdentifier | string | true | Pevious Unique Identifier. Required if you are seting Personalizer property | |
| NewIdentifier | string | true | New Unique Identifier. Required if you are seting Personalizer property |
Output / Result
| 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 Token Activity (GetActivity)
Return grouped token activity by time.
Get Token Activity (GetActivity)
Method Url
https://client.livedesignerfusion.com/{username}/Token/GetActivityParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | replace {username} with your fusion username in the method url before sending the request. | |
| UTCOffset | double | 0 | false | UTC Time offset. For example, This value will be -6 for MST Time Zone. |
Output / Result
Properties
| Name | Type | Description |
|---|---|---|
| success | string | Possible values "true", "false". Return true if successfully executed and return false if failed to execute. |
| Today | object | Object with Information for today's tokens. See object for more details |
| Week | object | Object with Information for Week's tokens. See object for more details |
| Month | object | Object with Information of Monthly tokens. See object for more details |
| Live | object | Object with Information of Live tokens. 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. |
Today
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of token's created today. |
| Dropped | int | Total Number of token's dropped today. |
| Saved | int | Saved token's for today. |
Week
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of token's created this week. |
| Dropped | int | Total Number of token's dropped this week. |
| Saved | int | Saved token's this week. |
Month
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of token's created this month. |
| Dropped | int | Total Number of token's dropped this month. |
| Saved | int | Saved token's this month. |
Live
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of Live token's |
Properties
| Name | Type | Description |
|---|---|---|
| Success | string | Possible values "true", "false". Return true if successfully executed and return false if failed to execute. |
| Today | object | Object with Information for today's tokens. See object for more details |
| Week | object | Object with Information for Week's tokens. See object for more details |
| Month | object | Object with Information of Monthly tokens. See object for more details |
| Live | object | Object with Information of Live tokens. 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. |
Today
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of token's created today. |
| Dropped | int | Total Number of token's dropped today. |
| Saved | int | Saved token's for today. |
Week
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of token's created this week. |
| Dropped | int | Total Number of token's dropped this week. |
| Saved | int | Saved token's this week. |
Month
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of token's created this month. |
| Dropped | int | Total Number of token's dropped this month. |
| Saved | int | Saved token's this month. |
Live
| Name | Type | Description |
|---|---|---|
| Total | int | Total Number of Live token's |
Get Token/Session Ranking (GetRanking)
Return grouped token ranking by ranking type and ready. This ranking is grouped by Ready Name.
Get Token/Session Ranking (GetRanking)
Method Url
https://client.livedesignerfusion.com/{username}/Token/GetRankingParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | replace {username} with your fusion username in the method url before sending the request. | |
| TimePeriod | string | today | false | Time Filter for result set. Allowed values Day,Week,Month,All) |
| RecordCount | int | 5 | false | How many redies to add in each grouping. |
Output / Result
Properties
| Name | Type | Description |
|---|---|---|
| success | string | Possible values "true", "false". Return true if successfully executed and return false if failed to execute. |
| Rankings | Array/List | List of Ranking. It will return three ranking (Requested, Saved,Dropped) 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. |
Rankings
| Name | Type | Description |
|---|---|---|
| Type | string | Type of Ranking. Possible values Requested, Saved or Dropped. |
| Total | int | Total Token/Sessions. |
| List | Array/List | List of readies under this ranking. See object for more details |
List
| Name | Type | Description |
|---|---|---|
| Token | string | ready Token Name. |
| Total | int | Total Number of token's for this ready. |
| Percentage | double | Percentage of the Ready for this grouping. |
| Name | string | Ready Name. |
Properties
| Name | Type | Description |
|---|---|---|
| Success | string | Possible values "true", "false". Return true if successfully executed and return false if failed to execute. |
| Rankings | Array/List | List of Ranking. It will return three ranking (Requested, Saved,Dropped) 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. |
Rankings
| Name | Type | Description |
|---|---|---|
| Type | string | Type of Ranking. Possible values Requested, Saved or Dropped. |
| Total | int | Total Token/Sessions. |
| List | Array/List | List of readies under this ranking. See object for more details |
List
| Name | Type | Description |
|---|---|---|
| Token | string | ready Token Name. |
| Total | int | Total Number of token's for this ready. |
| Percentage | double | Percentage of the Ready for this grouping. |
| Name | string | Ready Name. |
Search Token existence. (Exists)
Returns object with search results
Search Token existence. (Exists)
Method Url
https://client.livedesignerfusion.com/{username}/Token/Exists?parametersParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | replace {username} with your fusion username in the method url before sending the request. | |
| Token | string | true | Personalization token to be searched. |
Output / Result
Properties
| Name | Type | Description |
|---|---|---|
| success | string | Possible values "true", "false". Return true if successfully executed and return false if failed to execute. |
| exist | boolean | true or false based on search results. |
| token | string | personalization token value if it's searched. |
| 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. |
Properties
| Name | Type | Description |
|---|---|---|
| Success | string | Possible values "true", "false". Return true if successfully executed and return false if failed to execute. |
| Exist | boolean | true or false based on search results. |
| Token | string | personalization token value if it's searched. |
| 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 Token Stitch Player (GetStitchPlayer)
Render flash based stitch player. It's always suggested to render in iframe or new tab/window.
Get Token Stitch Player (GetStitchPlayer)
Method Url
https://client.livedesignerfusion.com/{username}/Token/GetStitchPlayer?parameterlistParameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| Token | string | true | Personalization Token. Generated and returned by personalization interface. | |
| 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
Composite Image (GetImage)
Retreive the composite image for personalization with product image. Size("Width"x"MaxHeight") 50x50, 100x100,200,400 will pre cached and request will be executed or served fast.
Composite Image (GetImage)
Method Url
https://client.livedesignerfusion.com/{username}/GetImage?{parameterlist}Parameters
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| {username}{username} | string | true | replace {username} with your fusion username in the method url before sending the request. | |
| Token | string | true | The instance token (returned in CompletePersonalization) | |
| Thumbnail | int | 0 | false | 0 if normal image 1 if thumbnail |
| Width | int | 0 | true | Width of the composite image or thumbnail. |
| MaxHeight | int | {Width} | false | Maximum Height of the requested Image. Default value is the equal to the width parameter value. |
Example 1: Image with width of 400
var url='https://client.livedesignerfusion.com/'+username+'/Token/GetImage?Token='+data.Token+'&Width=400';
Example 2: Thumbnail with width of 50
var url='https://client.livedesignerfusion.com/'+username+'/Token/GetImage?Token='+data.Token+'&ThumbnailWidth=50&Thumbnail=1';