Add New Custom Icons API
Require Authentication
This API is used to add new Custom Icons for the company based on combination of deviceID and token.
URL
api/manageassets/addcustomicons
Required parameter (POST)
- deviceID
- token
- iconURL «contain icon image in base64 encoded string
- iconURL_extension «contains icon image file extension, without dot. Only accept: "gif","png","jpg". Must be used together with iconURL.»
- iconName «contains icon name»
- iconOriginalFileName «contain icon image original file name, exclude file extension. Will only be saved if there is an image in iconURL.»
Optional parameter
- iconDescription
Example JSON Payload
{
"iconURL" : "{{someBase64}}",
"iconURL_extension" : "png",
"iconName" : "Icon Name",
"iconDescription" : "this is icon description",
"iconOriginalFileName" : "imagetitle.png",
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "bb602ab13b8090268cd6e3bb9dfa39e2"
}
Possible return HTTP status code
- 201
- 400
- 401
- 405
Return message, contains newly created Custom Icons
{
"status": "success",
"message": {
"iconName": "Icon Name",
"iconDescription": "this is icon description",
"iconOriginalFileName": "imagetitle.png",
"iconFileType": "image/png",
"iconFileSize": 14.857,
"companyID": 16,
"createdDate": 1692260220,
"creatorUserID": 90,
"iconURL": "6d84ea9c6d221976d51b448dbfbece5f.png",
"iconID": 75,
"fullIconURL": "https://wasteinsights-files.s3.ap-southeast-2.amazonaws.com/uploads/customicons/16/6d84ea9c6d221976d51b448dbfbece5f.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=1234567890ABCDeFGHIJ%2F20230817%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20230817T081700Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=123456789009876543214c286c6e40b37a46e04525cb28368990e206d741f216"
}
}