Get
/api/3/Cliparts/GetCliparts?websiteId={websiteId}&webApiClientKey={webApiClientKey}&folderCode={folderCode}&ruleCode={ruleCode}&pageSize={pageSize}&pageIndex={pageIndex}&searchKey={searchKey}
The Get Cliparts API is used to retrieve cliparts based on specific criteria such as folder and rule codes, along with pagination and search functionality. It helps in fetching categorized cliparts for further customization.
Request Information
Parameters
Parameter Name | Description |
WebsiteId (Int) | This param refers to the website associated with customized products. The admin user of Artifi can create one or more websites and assign products to each of them. The ID of the website with which specified customized products are associated should be specified in this parameter. |
WebApiClientKey (String) | When any company registers with Artifi, Artifi will generate a special and unique key for that company, which will be called the client key. This client key can be found in the registered company's profile tab in the Artifi Account. The client key will be used for client (company) authentication and will be referred to as WebApiClientKey. |
FolderCode | This parameter refers to a specific folder within the Artifi system that organizes and categorizes cliparts, templates, or other customizable assets. It helps in structuring content for easier retrieval and management. If provided, the API will filter the data based on the specified folder. |
RuleCode | This parameter refers to the clipart family folder where cliparts are categorized based on predefined rules. Each RuleCode represents a specific category of cliparts, allowing users to fetch data at the rule level. When making an API request, specifying the RuleCode ensures that only the cliparts under that particular category are retrieved. |
pageSize (Int) | This is an optional parameter, if no value is passed then the user will get all the customized product data collection in the ascending order. If PageIndex and PageSize are passed then only the related list would load. |
pageIndex (Int) | This is an optional parameter, if no value is passed then the user would get all the customized product data collection in the ascending order. If PageIndex and PageSize are passed then only the related list would load. |
searchKey (String) | This parameter refers to the keyword used to filter the results based on specific product attributes. If provided, only user photos matching the search key will be retrieved. |
Response Information
Response body formats
On Success
On success, this method will call back the JavaScript method in the website which is specified in the "successCallback" parameter with success Message.
Success Response:
{
"Response": "Success",
"Message": "",
"Data": {
"ClipartFamilyList": [
{
"Id": 80,
"Name": "Chocolates",
"DisplayName": null,
"DisplayOrder": 0,
"Code": "80",
"ImageUniqueName": null
}
],
"ClipartList": {
"FamilyId": 80,
"AssetCount": 1,
"AssetList": [
{
"Id": 899,
"UniqueName": "215dda16-29e2-49c6-8fcf-b2cd631ea333.png",
"ImageName": "letter_1",
"Width": 224,
"Height": 224,
"Code": "899",
"IsPrintImagePresent": false,
"PrintImageUniqueName": null,
"IsVector": false,
"VectorImageUniqueName": null,
"DisplayImageUniqueName": null,
"DisplayOrder": 0,
"EmbStitchCount": 0,
"EmbColorCount": 0,
"ThreadList": [],
"RenderingTypeId": 1
}
]
}
},
"ErrorCode": ""
}
On Error
On error, this method will call back the JavaScript method in the website which is specified in the "errorCallback" parameter with errorMessage.
Error Response:
{
"Response": "Error",
"Message": "Image type is unsupported.",
"Data": null,
"ErrorCode": "301"
}