Role check
The service tests if the email address is a functional one, belongs to a role, such als info, admin or office for example, rather than to a person.
Syntax | …/svc/2.0/address/role/<address> |
Example | …/svc/2.0/address/role/info@bar.com |
Parameter | An ASCII email address as last part of the URL |
Result
<roleStatus> <result>1</result> </roleStatus>
or
{"result": 1}
- result: the evaluation result
- 0: address does not contain a functional role
- 1: address contains a functional role
Functionality
The local part of the requests address is checked against the role database table. If a match is found a positive result (1) is returned.
Each execution of the check will be documented as a business event (database table business_event) with type 118.