Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Gets list of roles.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ RoleNos

 

nillable

Sets list of role numbers to be returned. Empty list or null value means that all the roles should be returned.

≡ RoleNo

xs:int

list


 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Roles

 

nillable

Gets list of roles.

≡ WSRole

 

list nillable


â–¡ AvailableLCIDs

 

nillable

Gets list of LCIDs of all the translations available for the role.

≡ LCID

xs:int

list


â–  CurrentLCID

xs:int

 

Gets current LCID.

â–¡ Description

xs:string

nillable

Gets role decription.

â–  IsDenyRole

xs:boolean

 

Returns true if the role is a deny role.

â–¡ Name

xs:string

nillable

Gets role name.

â–  Permissions

xs:unsignedLong

 

Get permissions mask. To get the list of codes use the GetPermissionConstants WebAPI operation.

â–  RoleNo

xs:int

 

Gets role number.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.