Sector Endpoint

Description

Endpoint

/v1/sector/<id>
GET endpoint for retrieving bounding box image measurements. Will return the sector resource as a model when available. This endpoint must support polling and so if the algorithm is still in progress the endpoint should return status code 202 Accepted with a status indicator in the header. see https://benramsey.com/blog/2008/04/http-status-201-created-vs-202-accepted/.

Model

Sector models will have the following fields once populated in mongo:

{
  "id": "dskladnasdknsldnal",
  "capture_id": "49uoujndklsand",
  "created_at": "2021-07-11",
  "updated_at": "2021-07-11",
  "elapsed": 2.34,
  "threshold": null,
  "gaussian_blur": null,
  "erosion_iterations": null,
  "dialation_iterations": null,
  "boxes": [
    {
      "tl_x": 10,
      "tl_y": 40,
      "width": 23,
      "height": 43
    },
    {
      "tl_x": 50,
      "tl_y": 50,
      "width": 46,
      "height": 54
    }
  ]
}