GET Designer/Services/GetCliparts?divisionId={divisionId}&websiteId={websiteId}&webApiClientKey={webApiClientKey}&productCode={productCode}&sku={sku}&isShowFolder={true}
Admin user of Artifi can upload as many clipart on Artifi server to make it available for users and users can use that clipart in customizing the products.
If your e-commerce website need all the clipart present for particular website that you have created in Artifi account, this method will be helpful.
This operation gives list of all clipart present in Artifi server for particular website id. This method requires the website id.
When this operation invokes, it call back the JavaScript method with data consist of details of all clipart present in the requested website (Height, Width, Name, Scope etc).
Request Information
Parameters
| Name | Descriptions |
| divisionId | Division created in Artifi server by Admin user contains all product and related details. This division contains the clipart, fonts, colors, product etc. This parameter represents the division of which clipart are required. |
| websiteId | This is the website with which products and images are associated. Admin user of Artifi can create one or more websites and assign products to each of the website. The Id of the website with which clipart are associated should be specified in this parameter. |
| webApiClientKey | When any company gets registered with Artifi, Artifi will generate a special and unique key for that company which will be called as client key. This client key will be found in registered company's profile tab in Artifi Account. This client key will be used for client(company) authentication and will be called as WebApiClientKey. |
| productCode | When product is launched by SKU and isShowAllAttributeForSKU property is true in that time Clipart SP will return data based on product code else it will return data based on SKU. |
| sku | When product is launched by SKU and isShowAllAttributeForSKU property is true in that time Clipart SP will return data based on product code else it will return data based on SKU. SKU is optional parameter. |
| isShowFolder | By using this parameter Clipart service method returns the clipart folder details.Default value is TRUE. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"Response": "sample string 1",
"Message": "",
"Data": {
"data": [
{
"Name": "sample string 1",
"IsPublic": true,
"Assets": [
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
},
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
},
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
}
],
"Id": 3,
"LoginUserId": 1
},
{
"Name": "sample string 1",
"IsPublic": true,
"Assets": [
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
},
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
},
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
}
],
"Id": 3,
"LoginUserId": 1
},
{
"Name": "sample string 1",
"IsPublic": true,
"Assets": [
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
},
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
},
{
"Extension": "sample string 1",
"ThumbUrl": "sample string 2",
"ThumbWidth": 3,
"ThumbHeight": 4,
"DefaultPath": "sample string 5",
"Name": "sample string 6",
"Type": "sample string 7",
"Height": 8,
"Width": 9,
"UniqueName": "sample string 10",
"ImageSizeInByte": 11,
"Ref_Id": 1,
"Code": "sample string 14",
"Id": 15,
"LoginUserId": 1
}
],
"Id": 3,
"LoginUserId": 1
}
],
"Id": 1,
"LoginUserId": 1
}
}