Artifi.GetCustomizedDesignImageList(integrationValues)
This operation returns list all the design images saved across specific customized product. For example, If a customized product have several views and each views have different designs.
These designs will be saved as images on Artifi server across particular customized product id.
This method returns all that design image's unique name and physical path on server, saved for specified customized product.
Request Information
Parameters
| Name | Description |
| integrationValues | integrationValues should be the object and should contain the Artifi data, which will include the following values. This values are not case sensitive.
customizedProductId: Id of the customized product whose design image list is required.
websiteId: This is the website with which customized product is 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 customized product is 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.
successCallback: This method returns the list of design images of specified customized product and pass this information to the JavaScript method. You have to create the success handler i.e., JavaScript method to collect this design image list, pass that JavaScript method name to this parameter. Specified JavaScript method will get called when method returns success as response.
errorCallback: You have to create the error handler (a JavaScript method) for this "GetCustomizedDesignImageList" method. If any error occurs during the process of getting design image list, this error handler will get called. You have to specify that error handler JavaScript method name in this parameter. Specified JavaScript method will get called when method returns error as response. |
Response Information
Response body formats
On Success
{
"Response":"Success",
"Message":null,
"Data":{
"CustomizedProductId":7093,
"List":[
{
"Name":"Test",
"ThumbnailImagePath":"thumbnail image path",
"ImagePath":"image path",
"Id":19084,
"LoginUserId":null
}
],
"ImageList3D":null,
"Id":0,
"LoginUserId":null
},
"ErrorCode":null
}On Error
On error, this method will call back the JavaScript method in website which is specified in "errorCallback" parameter with error information.