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

API: Role.ValidateDeleteRole

Scoped Name

APIServer.Role.ValidateDeleteRole

Interface

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

Description

Validates whether a role can be deleted. This API does not delete the role.

If the validation fails the *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.

This is the same validation that is performed when the Role.DeleteRole API is called.

Events

Universal events