Doc: DynamicOverlay API remove does not accept documented 'camera' parameter

[Manezki]

Hey! Ran into the following case while managing the overlays on an Axis camera.

Calling the DynamicOverlay API's remove method, with the documented required parameters 'camera' and 'identity' returns Unknown parameter. See below:

{
    "apiVersion": "1.7",
    "context": "RemoveOverlay()",
    "error": {
        "code": 103,
        "message": "Unknown parameter supplied"
    },
    "method": "remove"
}

It appears that 'camera' is not a recognized parameter for the method.

Camera information

curl -X POST -d '{"apiVersion": "1.0","context": "getAllProperties()","method": "getAllUnrestrictedProperties"}' http://CAMERA_IP/axis-cgi/basicdeviceinfo.cgi

{
"apiVersion": "1.3",
"data": {
    "propertyList": {
        "ProdNbr": "P3265-V",
        "HardwareID": "931.11",
        "ProdFullName": "AXIS P3265-V Dome Camera",
        "Version": "11.4.63",
        "ProdType": "Dome Camera",
        "Brand": "AXIS",
        "WebURL": "http://www.axis.com",
        "ProdVariant": "",
        "SerialNumber": "B8A44F3269F1",
        "ProdShortName": "AXIS P3265-V",
        "BuildDate": "Apr 21 2023 18:33"}},
"context": "getAllProperties()"}

Steps to reproduce

1. Add an overlay to Axis camera.
2. Query the overlays curl --digest -u xxxx:yyyy -X POST -d '{"apiVersion":"1.0","context":"ListOverlays()","method":"list","params":{"camera":1}}' http://CAMERA_IP/axis-cgi/dynamicoverlay/dynamicoverlay.cgi

Response:

{
    "apiVersion": "1.7",
    "context": "ListOverlays()",
    "data": {
        "imageFiles": [
            "/etc/overlays/axis(128x44).ovl",
            "/etc/overlays/testpic(228x140).ovl"
        ],
        "imageOverlays": [
            {
                "camera": 1,
                "identity": 1,
                "overlayPath": "/etc/overlays/axis(128x44).ovl",
                "position": [
                    -0.150282,
                    -0.092233999999999997
                ],
                "ptPosition": [
                    0.0,
                    0.0
                ],
                "scalable": false,
                "size": [
                    128,
                    44
                ],
                "visible": true,
                "zIndex": 0,
                "zoomInterval": [
                    1.0,
                    19999.0
                ]
            }
        ],
        "textOverlays": []
    },
    "method": "list"
}

3. Try removing the overlay from camera 1 with identity 1: curl --digest -u 'xxxx:yyyy' -X POST -d '{"apiVersion":"1.0","context":"RemoveOverlay()","method":"remove","params":{"camera":1, "identity": 1}}' http://CAMERA_IP/axis-cgi/dynamicoverlay/dynamicoverlay.cgi

Response:

{
    "apiVersion": "1.7",
    "context": "RemoveOverlay()",
    "error": {
        "code": 103,
        "message": "Unknown parameter supplied"
    },
    "method": "remove"
}

4. Try removing the overlay from camera 1 with identity 1 WITHOUT camera parameter: curl --digest -u 'xxxx:yyyy' -X POST -d '{"apiVersion":"1.0","context":"RemoveOverlay()","method":"remove","params":{"identity": 1}}' http://CAMERA_IP/axis-cgi/dynamicoverlay/dynamicoverlay.cgi

Response:

{
    "apiVersion": "1.7",
    "context": "RemoveOverlay()",
    "data": {},
    "method": "remove"
}

[github-actions[bot]]

This automatically generated reply acts as a friendly reminder.

Answers to your questions will most often come from the community, from developers like yourself. You will, from time to time, find that Axis employees answers some of the questions, but this is not a guarantee. Think of the discussion forum as a complement to other support channels, not a replacement to any of them.

If your question remains unanswered for a period of time, please revisit it to see whether it can be improved by following the guidelines listed in Axis support guidelines.

[vivekatoffice]

Hi @Manezki ,
Look like there is some issue in documentation where 'identity' and 'camera' both are 'Required' field but in examples only "identity" field is used.

VAPIX Reference

Good news 😊

Tested a Axis camera model with multiple sensors and identity is always unique.

[Manezki]

Cheers @vivekatoffice for checking the issue.

With the example using only the 'camera' parameter, and if it's indeed true that each overlay has a unique ID then it seems that the problem is more the documentation rather than the behaviour. I'll update the issue accordingly 👌

[vivekatoffice]

Hi @Manezki ,
Just wanted to update you on the changes in documentation.
Remove overlays