role.validate
Description
Validate field values from a role object. Please see Validating Objects for an overview of how the validate method works.
Note that there are validations that are performed upon update or create that cannot be performed from the validate method. Thus, even if validate returns TRUE, a create or update operation with the same values may still return an invalid object response.
Parameters
role
A partial role object, as described by the object.describe call. If a field in the role object is ommitted, no validation will be peformed for that field. If extra fields are passed, they will be ignored.
Response
TRUE is returned if all fields are valid, otherwise, an invalid object error object is returned.
Examples
A Sample JSON-RPC Role Validate Request
{
"method": "role.validate",
"params": [
{
"name": "example_role_name"
}
],
"id": 1
}The JSON-RPC Response
{
"result": true,
"error": null,
"id": 1
}Permissions Required
The user who owns the key used to authenticate the role.validate call must be a member of one of the following roles
- Administrator
- Program Manager
- Community Manager
See authentication.
Errors
In addition to the standard json-rpc errors and authentication errors, role.validate may also return these errors:
| HTTP Status Code | JSON-RPC Code | Error Message | Description |
|---|---|---|---|
| 400 | 1000 | Invalid Object | The object could not be updated because the object would be invalid. See Validating Objects for details on the format of this error. |