Superfy Platform API Documentation


Cancel Collect / De-Collect Specific Asset on Processed Route API

Require Authentication

This API is used to Cancel Collect / De-Collect Specific Asset on Processed Route for the company based on combination of deviceID and token.


URL

api/routes/decollectbin

Required parameter (POST)

Optional parameter

Example JSON Payload

{
  "deviceID": "ABCD-EFGH-IJKL-MNOP",
  "token": "2b6f3fc034d61fcbb75e52a9aab0c819", 
  "maintenanceScheduleProcessID": 5934,
  "projectpinID": 1326
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "defaultOrder": 0,
    "collected": "N",
    "missedReason": null,
    "collectionTime": 0,
    "lastCollectedData": {
      "ultrasound": 0,
      "averageDistance": 0,
      "laserDistance1": 0,
      "laserDistance2": 0,
      "laserAverageDistance": 0,
      "depthWhenEmpty_cm": 0,
      "distanceSensorToFillLine_cm": 0
    },
    "collectedBy": {},
    "projectpinID": 1326,
    "projectID": 87,
    "projectName": "Test Project",
    "projectgroupID": 17,
    "groupName": "ads",
    "iconType": "custom",
    "iconID": 1,
    "iconURL": "https://wasteinsights-files.s3.ap-southeast-2.amazonaws.com/uploads/customicons/16/01941e67f6472e3944539a044d895f96.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=1234567890AbCdEfghIJH%2F20230817%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20230817T140819Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=123456789009876543214c286c6e40b37a46e04525cb28368990e206d741f216",
    "customlocationID": 0,
    "locationName": "",
    "pinAddress1": "",
    "pinAddress2": "",
    "pinCity": "",
    "pinState": "",
    "pinCountry": "",
    "pinZipCode": "",
    "latitude": -6.156838134907,
    "longitude": 106.80628817528,
    "name": "test bin F",
    "description": "",
    "serialNumber": "",
    "assetTag": "",
    "manufacturerID": 0,
    "manufacturerName": "",
    "createdDate": 1607422183,
    "creatorUserID": 90,
    "pinType": {
      "pintypeID": 134,
      "pinTypeName": "bb test",
      "depthWhenEmpty_cm": 20,
      "distanceSensorToFillLine_cm": 2
    }
  }
}