Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: Role.DeleteRole

Scoped Name

APIServer.Role.DeleteRole

Interface

Field Variable ...as Description
RoleSurrogate Input Input The unique identification for the role.
NumberOfErrors Error Output The number of errors encountered and reported in the ErrorArray.
ErrorMessage ErrorArray (10) Output A description of an error, which has occurred during either validation or create.

Description

Checks whether the role can be deleted - and deletes the role if it is allowed.

If the validation fails the field Environment<*Returned status> is set to a non-successful value, and for each error an error message can be written in the ErrorArray output variable. The output field NumberOfErrors is set to the number of errors returned in ErrorArray.

Roles that are assigned to users or site elements can't be deleted (the API returns an error).

Note that the role is deleted from the database and can't be retrieved after a delete.

Events

Universal events