Get
/api/2/ImageSetting/GetImageSettingData?websiteId={websiteId}&webApiClientKey={webApiClientKey}
The Get Image Setting Data API retrieves the image settings configured for a specific website. This includes settings like file size limits, allowed image extensions, image DPI, and the folder name where the images are stored.
Request Information
Parameters
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": null,
"Data": {
"FileSize": {
"Name": "FileSize",
"DisplayName": "File Size (in MB)",
"DefaultValue": "5"
},
"ImageExtensions": [
{
"Name": "ImageExtensions",
"DisplayName": "Image Extensions",
"DefaultValue": "JPEG"
},
{
"Name": "ImageExtensions",
"DisplayName": "Image Extensions",
"DefaultValue": "JPG"
},
{
"Name": "ImageExtensions",
"DisplayName": "Image Extensions",
"DefaultValue": "PNG"
}
],
"ImageDPI": 90,
"CompanyPhysicalFolderName": "6A258451-6D74-446D-86B7-60BA3FEE04EC"
},
"ErrorCode": null
}
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": "Invalid webapiclientkey.",
"Data": null,
"ErrorCode": "226"
}