index #

The index is a numerical value associated with each object. It explicitly represents the order of objects of the same type.

For meter and barcode objects, the ordering of objects is random. Serial number objects are sorted on the basis of their confidence, whether they could be read, and whether they could be matched to an expected serialNumber specified in the request, with the best serial numbers appearing first.

For analog meters with two displays, it is assumed that the displays are aligned either horizontally or vertically. When they are aligned horizontally, the returned objects are returned left-to-right. When they are aligned vertically, the returned objects are returned top-to-bottom.

Version info
This response field has been added for meter objects in the 2020-10-01 release. It was already available in display, serial number and barcode objects.

Example response #

{
    "objects": [
        {
            "meter": {
                "index": 0,
                "objects": {
                    "display": [
                        {
                            "index": 0
                        },
                        {
                            "index": 1
                        }
                    ],
                    "serialNumber": [
                        {
                            "index": 0
                        }
                    ],
                    "barcode": []
                }
            }
        }
    ]
}