Read user rights

Resource type: checkuserrecordsright

Class: SmartMlInterfaceActionCheckUserRecordsRight
Action Type: Get

Reads out the user rights. Specify the type of right (action), module, userid and an array of recordIds. The response delivers a filtered array of recordIds, on which the user has read rights.

Parameters:

  • action
    STRING. Action. Possible values: read, delete, modify, create.
  • module
    STRING. Module. Possible values: folder, agents_log, calendar, address, estate, task, project, statistic, searchCriteria, file, emailDraft, objecttracking, smartsite2Root, pdfForms, agentslogMail
  • userid
    INTEGER. User ID
  • recordIds
    ARRAY. Record IDs.

Example: Reading out user read rights for user 17 on addressess 153 and 149

...
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
    "resourceid": "",
    "identifier": "",
    "resourcetype": "checkuserrecordsright",
    "parameters": {
        "action": "read",
        "module": "address",
        "userid": 17,
        "recordIds": [
            "153",
            "149"
        ]
    }
}
...

Response:

  • Elements. Record IDs where user has rights.

Response-Example: Reading out user read rights for user 17 on addressess 153 and 149

...
{
    "status": {
        "code": 200,
        "errorcode": 0,
        "message": "OK"
    },
    "response": {
        "results": [
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
                "resourceid": "",
                "resourcetype": "checkuserrecordsright",
                "cacheable": false,
                "identifier": "",
                "data": {
                    "meta": {
                        "cntabsolute": 1
                    },
                    "records": [
                        {
                            "id": 0,
                            "type": "",
                            "elements": [
                                "153"
                            ]
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}
...