Education Domains

Education domain check

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}

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.

Information about an education domain resource

The education info API call returns information about education resources.

Syntax …/svc/2.0/info/educationdomain/<id>
Example …/svc/2.0/info/educationdomain/bar.com
Parameter An ID (domain name) as the last part of the URL

Result

<educationDomainInfo>
    <addressAreaCode>6421</addressAreaCode>
    <addressCity>Marburg</addressCity>
    <addressFax>967-411</addressFax>
    <addressHomePage>www.bar.com</addressHomePage>
    <addressPhone>967-431</addressPhone>
    <addressPostbox></addressPostbox>
    <addressStreet>Dürerstraße 2011</addressStreet>
    <addressZipCode></addressZipCode>
    <countryCode>de</countryCode>
    <domains>
        <domain>bar.com</domain>
    </domains>
    <foundationYear>1909</foundationYear>
    <orgName>Evangelische Hochschule Bar</orgName>
    <orgSubtype>Theologische Hochschule</orgSubtype>
    <orgType>Fachhochschulen und Hochschulen ohne Promotionsrecht</orgType>
    <rightDoctorate>false</rightDoctorate>
    <rightHabilitation>false</rightHabilitation>
    <shortName>Marburg EH Bar</shortName>
    <sponsorship>privat, staatlich anerkannt</sponsorship>
    <state>Hessen</state>
    <students>69</students>
<educationDomainInfo>

or

{
     "addressAreaCode":"6421",
     "addressCity":"Marburg",
     "addressFax":"967-411",
     "addressHomePage":"www.bar.com",
     "addressPhone":"967-431",
     "addressPostbox":"",
     "addressStreet":"Dürerstraße 2011",
     "addressZipCode":""
     "countryCode":"de",
     "domains": ["bar.com"],
     "foundationYear":1909,
     "orgName":"Evangelische Hochschule",
     "orgType":"Fachhochschulen und Hochschulen ohne Promotionsrecht",
     "orgSubtype":"Theologische Hochschule",
     "rightDoctorate":false,
     "rightHabilitation":false,
     "shortName":"Marburg EH Bar",
     "sponsorship":"privat, staatlich anerkannt",
     "state":"Hessen"
     "students":69,
}

The result document can contain multiple domains that act as IDs for that institution. The document further provides address and other self-explanatory data about the educational organization.

Functionality

If no data is available for an ID the server will signal this with HTTP response code 204 (No Content) and return no result (null).

Each execution of the call will be documented as a business event (database table business_event) with type 123.