regis

<back to all web services

PersonSearchRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/search/page/{Page}
POST/person/search
"use strict";
export class PersonSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,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?:string,is_student?:boolean,is_faculty?:boolean,is_vendor?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    ubc_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    first_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    phone_bus;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {?string} */
    dob;
    /** @type {boolean} */
    is_student;
    /** @type {boolean} */
    is_faculty;
    /** @type {boolean} */
    is_vendor;
}
export class PersonSearchResponse {
    /** @param {{responseStatus?:ResponseStatus,persons?:PersonSimpleResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {PersonSimpleResponse[]} */
    persons;
}
export class PersonSearchRequest {
    /** @param {{page?:number,regent_id?:number,regent_login?:string,name?:string,last_name?:string,email?:string,phone?:string,dob?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    page;
    /** @type {?number} */
    regent_id;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    phone;
    /** @type {?string} */
    dob;
}

JavaScript PersonSearchRequest DTOs

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 /person/search/page/{Page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
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: 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"}},"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}]}