Skip to main content

Image Upload

Upload the images to Coolr System from 3rd party cameras/ mobiles etc

POST /controllers/CoolrAPI.ashx?action=uploadImage
  • Data must be posted in form-data format
  • Multiple images can be posted for related asset/ store in a single call

Parameters

ParameterTypeRequiredDescription
actionstringYesuploadImage
serialNumberstringNoAsset serial number. Required only if image is related to an asset
storeNumberstringNoLocation Code. Required only if image is generic for the stoer and asset serial number is not available
sceneTypestringNoScene Type. For acceptable values, see below
callbackUrlstringNoCallback Url. A url where results will be posted after image processing

sceneType options

  • ProductAnalysis - (Default) - For image of an asset for product analysis
  • AssetBarcode - For barcode detection
  • AssetView - Asset outside image. For asset condition analysis/ reference
  • StoreView - Store outside image
  • Promotion - To detect promotional product content |

Response

[
{
"Info": "Image uploaded successfully",
"UniqueGuid": "07b45ec5-9fe8-437c-af80-4490e19ae8a5",
"Success": true
},
{
"Info": "Image uploaded successfully",
"UniqueGuid": "bc31d26e-42e3-4d5f-b597-8630ac333256",
"Success": true
}
]

As you can upload multiple images, you'll one entry for each uploaded for file. The properties are:

  • Success (Boolean): Whether image was successfully accepted
  • Info (String): Success/ error message
  • UniqueGuid (String, Optional): Unique identifier for image for future reference. This is returned only if image was successfully uploaded.

Potential Failure Reasons

  • Asset Serial or Store Number not sent when required
  • If both Asset Serial and Store Number are sent but there is mismatch as per Coolr database
  • No images are sent
  • Image is corrupted