Child pages
  • EmailVerification Web Service Documentation

This wiki has been moved to byuitdocs.atlassian.net. It is no longer kept current. Please update your bookmarks to reflect this change.

Skip to end of metadata
Go to start of metadata

This web service is designed to check if an email address is a valid byu.edu address. This covers 3 pieces of information:

  • Whether the email address provided is really in the byu domain(byu.edu, byu.net)
  • Whether the email is listed in the LDAP database
  • Whether the email forwards to a BYU address

URL

https://ws.byu.edu/services/emailVerification-v1/xml/<email Address>
https://ws.byu.edu/services/emailVerification-v1/json/<email Address>
https://ws.byu.edu/services/emailVerification-v1/text/<email Address>

@container URL = server where the service is located
@email Address = The email address to be verified
Each URL represents the data type expected: XML, JSON, and plain text.

Example: https://ws.byu.edu/services/emailVerification-v1/xml/jdizzle@byu.edu will check jdizzle@byu.edu to see if it is listed in LDAP and return xml data.

Example: https://ws.byu.edu/services/emailVerification-v1/json/fakeaddress@byu.net will check fakeaddress@byu.net to see if it is listed in LDAP and return json data.

Returns

Example XML format :

<response>
<internalForwarding>false</internalForwarding>
<isListed>true</isListed>
<byuDomain>true</byuDomain>
</response>


Example JSON format:
{ "internalForwarding":true, "isListed":true, "byuDomain":true }


Example plain text format:

BYU domain : true, Listed in LDAP : true, Forwards to BYU address : true
  • No labels