regis

RegentLoginPersonMatchRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/RegentLogin/PersonMatch

"use strict";
export class RegentLoginPersonMatchResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,birthdate_exists?:boolean,birthdate_matches?:boolean,has_regent_login?:boolean,is_a_regis_person?:boolean,email_matches?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {?number} */
    regent_id;
    /** @type {boolean} */
    birthdate_exists;
    /** @type {boolean} */
    birthdate_matches;
    /** @type {boolean} */
    has_regent_login;
    /** @type {boolean} */
    is_a_regis_person;
    /** @type {boolean} */
    email_matches;
}
export class RegentLoginPersonMatchRequest {
    /** @param {{first_name?:string,last_name?:string,email?:string,dob?:string,regent_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {?string} */
    dob;
    /** @type {?number} */
    regent_id;
}

JavaScript RegentLoginPersonMatchRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	first_name: String,
	last_name: String,
	email: String,
	dob: 0001-01-01,
	regent_id: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
}