Required permission: | SearchPerson |
POST | /student/search | ||
---|---|---|---|
POST | /student/search/page/{Page} |
"use strict";
export class StudentSearchRequest {
/** @param {{page?:number,reporting_term?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
page;
/** @type {string} */
reporting_term;
}
JavaScript StudentSearchRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /student/search HTTP/1.1
Host: data.regent-college.edu
Accept: application/json
Content-Type: application/json
Content-Length: length
{"page":0,"reporting_term":"String"}
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,"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}]