The service tests whether an email address belongs to a domain related to an educational institution.
Syntax | …/svc/2.0/address/educationdomain/<address> |
Example | …/svc/2.0/address/educationdomain/foo@bar.com |
Parameter | An ASCII email address as last part of the URL |
Result
<educationDomainStatus> <infoId>bar.com</infoId> <result>1</result> </educationDomainStatus>
or
{"infoId": "bar.com", "result": 1}
- result: the evaluation result
- 0: no company domain found
- 1: company domain found
- infoId: if result == 1, this contains the ID (domain name) for looking up more information about an education domhain resource.
Functionality
The domain of the requests address is checked against the education_domain database table. If a match is found a positive result (1) is returned. The ID of the matching entry, the domain name, is also returned for further lookup.
Each execution of the check will be documented as a business event (database table business_event) with type 122.