regis

<back to all web services

RegentLoginPersonMatchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/RegentLogin/PersonMatch
RegentLoginPersonMatchRequest Parameters:
NameParameterData TypeRequiredDescription
first_namebodystringNo
last_namebodystringNo
emailbodystringNo
dobbodyDateTime?No
regent_idbodyint?No
RegentLoginPersonMatchResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformint?No
birthdate_existsformboolNo
birthdate_matchesformboolNo
has_regent_loginformboolNo
is_a_regis_personformboolNo
email_matchesformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RegentLogin/PersonMatch HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"first_name":"String","last_name":"String","email":"String","dob":"0001-01-01T00:00:00.0000000","regent_id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"birthdate_exists":false,"birthdate_matches":false,"has_regent_login":false,"is_a_regis_person":false,"email_matches":false}