POST Designer/Services/GetClipartsByClipartCode?websiteId={websiteId}&webApiClientKey={webApiClientKey}&clipartCode={ClipartCode}&clipartLogoCode={ClipartLogoCode}

Admin user of Artifi can upload as many cliparts on Artifi server to make it available for users and users can use that cliparts in customizing the products.

This operation gives list of all clipart present in Artifi server for particular Clipart Code or Clipart Logo Code This method requires the website id, webApiClientKey Clipart code and Clipart Logo Code .

Request Information

Parameters

Name	Descriptions
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 cliparts 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.
clipartCode[Optional]	This is a code that is associated with cliparts. Passing the Clipart Code in the API will return the details of the associated clipart.
clipartLogoCode[Optional]	This is a code that is associated with cliparts. One logo code value can be associated with multiple values. Passing the Logo Code in the API will return the details of the associated cliparts.

Response Information

Response Body

application/json, text/json

Sample:
{
  "Response": "Success",
  "Message": "",
  "Data": {
    "ErrorModel": null,
    "Cliparts": [
      {
         "ClipartId": 11136,
         "ClipartName": "sample string 1", 
         "Height":100, 
         "Width": 100, 
         "ClipartUniqueName":  "sample string 2",
         "Code": "sample string 3", 
         "PrintImageMimeType": "sample string 4", 
         "PrintImageUniqueName": "sample string 5", 
         "PrintImageURL": "sample string 6", 
         "DisplayImageUniqueName": "sample string 7", 
         "DisplayImageURL": "sample string 8",                            
         "ClipartFamilyId": 1, 
         "ClipartFamilyName": "sample string 9", 
         "NoOfColors": 1, 
         "DefaultHexColor": "sample string 10",  
         "CustomClipartCode": "sample string 11",  
         "ImageOriginalURL": "sample string 12",   
         "ClipartThumbnailURL": "sample string 13" ,
         "DisplayImageThumbnailURL": "sample string 14"     
      },
      {
         "ClipartId": 11137,
         "ClipartName": "sample string 1", 
         "Height":100, 
         "Width": 100, 
         "ClipartUniqueName":  "sample string 2",
         "Code": "sample string 3", 
         "PrintImageMimeType": "sample string 4", 
         "PrintImageUniqueName": "sample string 5", 
         "PrintImageURL": "sample string 6", 
         "DisplayImageUniqueName": "sample string 7", 
         "DisplayImageURL": "sample string 8",                            
         "ClipartFamilyId": 1, 
         "ClipartFamilyName": "sample string 9", 
         "NoOfColors": 1, 
         "DefaultHexColor": "sample string 10",  
         "CustomClipartCode": "sample string 11",  
         "ImageOriginalURL": "sample string 12",   
         "ClipartThumbnailURL": "sample string 13" ,
         "DisplayImageThumbnailURL": "sample string 14"     
      }                        
    ],
   "TotalRecords":2
  },
    "ErrorCode":null 
 }

Properties and Descriptions

Field	Type	Details
ClipartId	int	Artifi ClipartId
Height	int	Height of Clipart in Pixel.
Width	int	Width of Clipart in Pixel.
ClipartName	string	Name of Clipart.
DisplayName	string	Display name of Clipart.
Code	string	Code of Clipart.
DisplayOrder	int	Display Order of Clipart.
ClipartUniqueName	string	Unique Name of Clipart.
ImageOriginalURL	string	Clipart Original URL.
DisplayImageURL	string	Clipart Display Image URL.
PrintImageURL	string	Clipart Print Image URL.
PrintImageMimeType	string	Clipart Print Image Mime Type. This field will return if any print image associated with this clipart in Artifi Admin.
NoOfColors	int	No. of Clipart Colors.
DefaultHexColor	string	Hexadecimal Color Code of Clipart.
CustomClipartCode	string	Custom Clipart Code.
ClipartFamilyId	int	Artifi Family Id of Clipart.
ClipartFamilyName	string	Clipart Family Name.
ClipartThumbnailURL	string	Thumbnail Url of Clipart.
DisplayImageThumbnailURL	string	Thumbnail Url of Clipart Display Image.
TotalRecords	int	Total No. of Records associated with this Clipart Family.

On Failure

On failure, this method will return the following response based on parameters.

If the webApiClientKey is passed as null or not provided, then it will give the response.

{
  "Response": "WebApiclientKey should not be empty or null.",
  "Message": null,
  "Data": null
}
                            
If the websiteId is passed as 0, then it will give the response.
{
  "Response": "Website Id should not be empty or null.",
  "Message": null,
  "Data": null
}
If the ClipartCode does not exist, then it will give the response.
{
  "Response": "Invalid Clipart Code.",
  "Message": null,
  "Data": null
}
If the websiteId does not exist, then it will give the response.
{
  "Response": "Invalid website Id.",
  "Message": null,
  "Data": null
}
If the webApiClientKey does not exist, then it will give the message.
{
  "Response": "Invalid webApiclientKey.",
  "Message": null,
  "Data": null
}