Obseron REST API - Groups and permissions

Groups and permissions

Endpoint: https://server:port/api/groups

Supported actions: GET, POST, DELETE, PATCH

Examples

GET    https://server:port/api/groups
GET    https://server:port/api/groups/c6d6ef81-2dfe-411a-8bee-e16137b1b135
POST   https://server:port/api/groups
DELETE https://server:port/api/groups/c6d6ef81-2dfe-411a-8bee-e16137b1b135

Required permissions for each action

GET:    accessSettings
POST:   managePermissions
DELETE: managePermissions
PATCH:  managePermissions

POST Request content to add a new group, specifying all data fields:

{
    "isDefault": false,
    "name": "New Group",
    "permissions": {
        "cameras": {
            "permitAllCameras": true,
            "permittedCameras": []
        },
        "features": {
            "accessLicence": true,
            "accessSettings": true,
            "acknowledgeSystemErrors": true,
            "allowRemote": true,
            "usingGallery": true,
            "viewLive": true,
            "viewRecordings": true,
            "viewSystemErrors": true,
            "viewUserLog": true
        },
        "licensePlateRecognition": {
            "browseLpr": true,
            "browseOtherLpr": true,
            "manageCameraRoles": true,
            "managePermits": true,
            "manageVehicles": true,
            "manageVehiclesInArea": true,
            "permitDuration": 20
        },
        "settings": {
            "addCameras": true,
            "addDevices": true,
            "configureDevices": true,
            "congigureCameras": true,
            "managePermissions": true,
            "manageRules": true,
            "manageStorage": true,
            "manageUsers": true
        },
        "tasks": {
            "controlPtz": true,
            "createVideoclips": true,
            "quitProgram": true,
            "readSharebox": true,
            "savePresets": true,
            "takeSnapshots": true,
            "usingAudio": true,
            "writeSharebox": true
        },
        "interface": {
            "accessEditMode": true,
            "importExportTabs": true
        }

    }
}

POST Response:

{
    "id": "4df9c699-4c25-4dc1-8e4f-41189ab1c058",
    "isDefault": false,
    "name": "New Group",
    "permissions": {
        "cameras": {
            "permitAllCameras": true,
            "permittedCameras": []
        },
        "features": {
            "accessLicence": true,
            "accessSettings": true,
            "acknowledgeSystemErrors": true,
            "allowRemote": true,
            "usingGallery": true,
            "viewLive": true,
            "viewRecordings": true,
            "viewSystemErrors": true,
            "viewUserLog": true
        },
        "licensePlateRecognition": {
            "browseLpr": true,
            "browseOtherLpr": true,
            "manageCameraRoles": true,
            "managePermits": true,
            "manageVehicles": true,
            "manageVehiclesInArea": true,
            "permitDuration": 20
        },
        "interface": {
            "accessEditMode": true,
            "importExportTabs": true
        },
        "settings": {
            "addCameras": true,
            "addDevices": true,
            "configureDevices": true,
            "congigureCameras": true,
            "managePermissions": true,
            "manageRules": true,
            "manageStorage": true,
            "manageUsers": true
        },
        "tasks": {
            "controlPtz": true,
            "createVideoclips": true,
            "quitProgram": true,
            "readSharebox": true,
            "savePresets": true,
            "takeSnapshots": true,
            "usingAudio": true,
            "writeSharebox": true
        }
    }
}

POST Request content to add a new group, leaving some data fields empty:

{
    "isDefault": true,
    "name": "New Group 2",
    "permissions": {
        "features": {
            "accessLicence": true,
            "accessSettings": true,
            "acknowledgeSystemErrors": true,
            "allowRemote": true,
            "usingGallery": true,
            "viewLive": true,
            "viewRecordings": true,
            "viewSystemErrors": true,
            "viewUserLog": true
        }
    }
}

POST Response:

{
    "id": "865ac031-6f70-4a0e-9b58-97740862c387",
    "isDefault": true,
    "name": "New Group 2",
    "permissions": {
        "cameras": {
            "permitAllCameras": true,
            "permittedCameras": []
        },
        "features": {
            "accessLicence": true,
            "accessSettings": true,
            "acknowledgeSystemErrors": true,
            "allowRemote": true,
            "usingGallery": true,
            "viewLive": true,
            "viewRecordings": true,
            "viewSystemErrors": true,
            "viewUserLog": true
        },
        "licensePlateRecognition": {
            "browseLpr": false,
            "browseOtherLpr": false,
            "manageCameraRoles": false,
            "managePermits": false,
            "manageVehicles": false,
            "manageVehiclesInArea": false,
            "permitDuration": 0
        },
        "interface": {
            "accessEditMode": true,
            "importExportTabs": true
        },
        "settings": {
            "addCameras": false,
            "addDevices": false,
            "configureDevices": false,
            "congigureCameras": false,
            "managePermissions": false,
            "manageRules": false,
            "manageStorage": false,
            "manageUsers": false
        },
        "tasks": {
            "controlPtz": false,
            "createVideoclips": false,
            "quitProgram": false,
            "readSharebox": false,
            "savePresets": false,
            "takeSnapshots": false,
            "usingAudio": false,
            "writeSharebox": false
        }
    }
}