regis

<back to all web services

RegentLoginPersonMatchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/RegentLogin/PersonMatch

export class RegentLoginPersonMatchResponse
{
    public responseStatus: ResponseStatus;
    public regent_id?: number;
    public birthdate_exists: boolean;
    public birthdate_matches: boolean;
    public has_regent_login: boolean;
    public is_a_regis_person: boolean;
    public email_matches: boolean;

    public constructor(init?: Partial<RegentLoginPersonMatchResponse>) { (Object as any).assign(this, init); }
}

export class RegentLoginPersonMatchRequest
{
    public first_name: string;
    public last_name: string;
    public email: string;
    public dob?: string;
    public regent_id?: number;

    public constructor(init?: Partial<RegentLoginPersonMatchRequest>) { (Object as any).assign(this, init); }
}

TypeScript RegentLoginPersonMatchRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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: text/jsonl
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}