Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/HasRolePermissions

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/HasRolePermissions

 

Checks if the currently logged on user has the specified role permissions for the specified objects.

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/HasRolePermissions

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ ObjectsToCheck

 

mandatory nillable

Sets the list of objects with role access masks to check role permissions.

≡ HasRolePermissionsParamsItem

 

list nillable


â–¡ AccessMask

 

nillable

Sets the role permission access mask.

â–  Value

xs:unsignedLong

 

Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.

â–  ObjNo

xs:int

 

Sets the object number.

â–  ObjType

 

 

restriction enum (xs:string)

- Unknown (-1)

- Server (1)

- Document (2)

- Category (3)

- Field (4)

- DataType (5)

- MediaPool (6)

- Media (7)

- IndexingProfile (8)

- SpoolType (9)

- Query (10)

- User (11)

- Group (12)

- CaptureProfile (13)

- PreProcessor (14)

- COLDForm (15)

- QueryTemplate (16)

- Folder (17)

- LoaderProfile (18)

- WorkflowProcess (19)

- WorkflowTask (20)

- WorkflowInstance (21)

- KeyDict (22)

- StoragePolicy (23)

- Device (24)

- StorageArea (25)

- RetentionPolicy (26)

- Count (27)

- UniversalConnectorProfile (29)

- CaseDefinition (37)

- Case (38)

- Stamp (40)

- ReportDefinition (41)

- eForm (47)

- eFormSubmission (48)

- FormImage (99)

- Keyword (100)

- Migrate (101)

- Connectors (900)

- StorageCtgry (901)

- ServerMediaPools (902)

- StorageAreaMedia (903)

- ServerDevices (904)

- ServerMedia (905)

- TheSystem (1000)

- COLD (1001)

- ExchangeConnector (1002)

- LotusConnector (1003)

- SAPConnector (1004)

Sets the object type.

â–  SubObjNo

xs:int

 

Sets the sub-object number or 0 (zero).

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/HasRolePermissionsResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ ObjectsList

 

nillable

Gets the list of objects with role permissions check result.

≡ HasRolePermissionsResponseItem

 

list nillable


â–¡ ErrorCodeHex

xs:string

nillable

Gets error code if 'HasRolePermission' property is null.

â–¡ ErrorMessage

xs:string

nillable

Gets error message if 'HasRolePermission' property is null.

â–¡ HasRolePermission

xs:boolean

nillable

Returns 'true' if the user has requested role permissions, otherwice returns 'false'. Returns 'null' in case of an error (for error details see ErrorCodeHex and ErrorMessage properties).

â–  ObjNo

xs:int

 

Gets the object number.

â–  ObjType

 

 

restriction enum (xs:string)

- Unknown (-1)

- Server (1)

- Document (2)

- Category (3)

- Field (4)

- DataType (5)

- MediaPool (6)

- Media (7)

- IndexingProfile (8)

- SpoolType (9)

- Query (10)

- User (11)

- Group (12)

- CaptureProfile (13)

- PreProcessor (14)

- COLDForm (15)

- QueryTemplate (16)

- Folder (17)

- LoaderProfile (18)

- WorkflowProcess (19)

- WorkflowTask (20)

- WorkflowInstance (21)

- KeyDict (22)

- StoragePolicy (23)

- Device (24)

- StorageArea (25)

- RetentionPolicy (26)

- Count (27)

- UniversalConnectorProfile (29)

- CaseDefinition (37)

- Case (38)

- Stamp (40)

- ReportDefinition (41)

- eForm (47)

- eFormSubmission (48)

- FormImage (99)

- Keyword (100)

- Migrate (101)

- Connectors (900)

- StorageCtgry (901)

- ServerMediaPools (902)

- StorageAreaMedia (903)

- ServerDevices (904)

- ServerMedia (905)

- TheSystem (1000)

- COLD (1001)

- ExchangeConnector (1002)

- LotusConnector (1003)

- SAPConnector (1004)

Gets the object type.

â–  SubObjNo

xs:int

 

Gets the sub-object number or 0 (zero).

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2025 Therefore Corporation, all rights reserved.