Get
/api/3/UploadImage/GetUserUploadedList?websiteId={websiteId}&webApiClientKey={webApiClientKey}&userId={userId}&pageSize={pageSize}&pageIndex={pageIndex}&searchKey={searchKey}
The Get User Uploaded List API provides a list of images or assets uploaded by a specific user on the Artifi platform. This API helps fetch the uploaded items, with the option to filter results using page sizes, indexes, and search keywords.
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. |
userId (String) | This will be the id of your e-commerce website's user. The user can be a registered or guest user. If the user is registered, pass the user id in this parameter, and if the user is not registered with your e-commerce website, create a temporary id for the user and pass that temporary id in this parameter. The non-registered users are called as guest users, and this is their unique user ID |
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.
{
"Response": "Success",
"Message": "",
"Data": {
"AssetList": [],
"AssetCount": 0
},
"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.
{
"Response": "Error",
"Message": "Invalid website id.",
"Data": null,
"ErrorCode": "221,234"
}