regis

PersonSearchRequest

**Requires Authentication**
Required permission:	SearchPerson

The following routes are available for this service:
POST	/person/search/page/{Page}
POST	/person/search


export class PersonSimpleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public ubc_id?: number;
    public uuid: string;
    public regent_login: string;
    public first_name: string;
    public preferred_name: string;
    public middle_name: string;
    public last_name: string;
    public email: string;
    public phone_home: string;
    public phone_cell: string;
    public phone_bus: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public dob?: string;
    public is_student: boolean;
    public is_faculty: boolean;
    public is_vendor: boolean;

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

export class PersonSearchResponse
{
    public responseStatus: ResponseStatus;
    public persons: PersonSimpleResponse[];

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

export class PersonSearchRequest
{
    public page?: number;
    public regent_id?: number;
    public regent_login: string;
    public name: string;
    public last_name: string;
    public email: string;
    public phone: string;
    public dob?: string;

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

TypeScript PersonSearchRequest 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 /person/search/page/{Page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"page":0,"regent_id":0,"regent_login":"String","name":"String","last_name":"String","email":"String","phone":"String","dob":"0001-01-01T00:00:00.0000000"}

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"}},"persons":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false}]}