Therefore Web API Programming Interface 1.0

GetRoles

Scroll

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		optional 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	optional unbounded

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ Roles		optional nillable	Gets list of roles.
≡ WSRole		optional unbounded nillable
□ AvailableLCIDs		optional nillable	Gets list of LCIDs of all the translations available for the role.
≡ LCID	xs:int	optional unbounded
■ CurrentLCID	xs:int	optional	Gets current LCID.
□ Description	xs:string	optional nillable	Gets role decription.
■ IsDenyRole	xs:boolean	optional	Returns true if the role is a deny role.
□ Name	xs:string	optional nillable	Gets role name.
■ Permissions	xs:unsignedLong	optional	Get permissions mask. To get the list of codes use the GetPermissionConstants WebAPI operation.
■ RoleNo	xs:int	optional	Gets role number.

Legend:

■	Not nillable element.
□	Nillable element.
≡	Unbounded element (List of elements).
Normal	Optional element.
Bold	Mandatory element.