Method GetObjectPermissions

GetObjectPermissions(String, RequestSettingsContract, String)

Get the object permissions of 'name' in the context of the role of the user

Declaration

ObjectPermissionsResultContract GetObjectPermissions(string connectionId, RequestSettingsContract requestSettings, string name)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
RequestSettingsContract	requestSettings	Request settings, e.g. Language
System.String	name	The name of the object for which the permissions are to be obtained, see ObjectsEnum

Returns

Type	Description
ObjectPermissionsResultContract	Returns the object permissions

Examples

PUT http://YourServerName/InfoShare/Json/Invoice/GetObjectPermissions

Example for get object permissions.

{
   "connectionId": "b6742bb8-ef97-44ae-819b-a2fa2200908a",
   "requestSettings":
   {
        "Language": "de"
   },
   "name": "GlAccount"
}

Response:

{
   "FieldPermissions": [
       {
           "CanRead": true,
           "CanUpdate": true,
           "Name": "Blocked"
       },
       {
           "CanRead": true,
           "CanUpdate": true,
           "Name": "BlockedFrom"
       },
       {
           "CanRead": true,
           "CanUpdate": false,
           "Name": "CompanyNumber"
       },
       ...
       ..
       .
   ],
   "GeneralPermissions":
   {
       "CanCreate": true,
       "CanDelete": true,
       "CanRead": true,
       "CanUpdate": true
   },
   "Name": "GlAccount",
   "RequestResult":
   {
       "Error": null,
       "Messages": null,
       "Result": "Valid"
   }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Verification code is needed: Verification code not yet verified (10152)