messages #

Each object in the response always contains a list of messages, even when this list is empty. This list contains messageIds. The actual contents of the messages are returned at the top-level messages property.

Example response #

{
    "messages":[
        {
            "code":"uneven_displays",
            "message":"Displays with different numbers of digits have been found.",
            "messageId":"m-BaPCeDMg",
            "objectId":"o-GsWyEHGw"
        },
        {
            "code":"short_display",
            "message":"Only a few digits of this display have been read. It might be an incomplete reading.",
            "messageId":"m-bBzgy8rC",
            "objectId":"o-chL8oW88"
        }, 
        {
            "code": "no_valid_gps_location",
            "message": "No valid GPS information could be extracted from the image.",
            "messageId": "m-4Rxthan7"
        }
    ],
    "objects":{
        "meter":[
        {
            "objectId":"o-GsWyEHGw",
            "messages":["m-BaPCeDMg"],
            "objects":{
                "display":[
                    {
                        "objectId":"o-chL8oW88",
                        "messages":["m-bBzgy8rC"]
                    }
                ], 
                "serialNumber": [
                    {
                        "objectId":"o-g9gte4gS",
                        "messages":[]
                    }
                ], 
                "barcode": []
            }
        }
        ]
    }
}

Example response from API version 2024-03-01 #

{
    "messages":[
        {
            "code":"uneven_displays",
            "message":"Displays with different numbers of digits have been found.",
            "messageId":"m-BaPCeDMg",
            "objectId":"o-GsWyEHGw"
        },
        {
            "code":"short_display",
            "message":"Only a few digits of this display have been read. It might be an incomplete reading.",
            "messageId":"m-bBzgy8rC",
            "objectId":"o-chL8oW88"
        }, 
        {
            "code": "no_valid_gps_location",
            "message": "No valid GPS information could be extracted from the image.",
            "messageId": "m-4Rxthan7"
        }
    ],
    "objects":{
        "meter":[
        {
            "objectId":"o-GsWyEHGw",
            "messages":["m-BaPCeDMg"],
            "objects":{
                "display":[
                    {
                        "objectId":"o-chL8oW88",
                        "messages":["m-bBzgy8rC"]
                    }
                ], 
                "serialNumber": [
                    {
                        "objectId":"o-g9gte4gS",
                        "messages":[]
                    }
                ], 
                "barcode": [],
                "datamatrix": [],
                "qrCode": []
            }
        }
        ]
    }
}