| Required role: | REGISUserRole |
| POST | /person/{uuid}/addressAndBio |
|---|
"use strict";
export class PersonExtendedResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,spouse_regent_id?:number,uuid?:string,regent_login?:string,spouse_rwl?:string,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,birth_name?:string,override_transcript_name?:string,spouse_name?:string,addr1?:string,addr2?:string,country?:string,state?:string,city?:string,code?:string,phone_home?:string,phone_cell?:string,phone_bus?:string,email?:string,prefix?:string,dob?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,denomination?:string,occupation?:string,ethnicity?:string,gender?:string,marital_status?:string,deceased_date?:string,is_donor?:boolean,is_vendor?:boolean,is_gp_customer?:boolean,crm_student_status?:string,crm_assigned?:string,last_registered_term?:string,added_by?:string,added_date?:string,last_changed_by?:string,last_changed_date?:string,addr_last_changed_by?:string,addr_last_changed_date?:string,tax_number?:string,regent_current_program?:string,regent_degrees?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {?number} */
ubc_id;
/** @type {?number} */
spouse_regent_id;
/** @type {string} */
uuid;
/** @type {string} */
regent_login;
/** @type {string} */
spouse_rwl;
/** @type {string} */
first_name;
/** @type {string} */
middle_name;
/** @type {string} */
last_name;
/** @type {string} */
preferred_name;
/** @type {string} */
birth_name;
/** @type {string} */
override_transcript_name;
/** @type {string} */
spouse_name;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
country;
/** @type {string} */
state;
/** @type {string} */
city;
/** @type {string} */
code;
/** @type {string} */
phone_home;
/** @type {string} */
phone_cell;
/** @type {string} */
phone_bus;
/** @type {string} */
email;
/** @type {string} */
prefix;
/** @type {?string} */
dob;
/** @type {string} */
citizenship;
/** @type {string} */
citizenship_other;
/** @type {string} */
permanent_resident;
/** @type {string} */
denomination;
/** @type {string} */
occupation;
/** @type {string} */
ethnicity;
/** @type {string} */
gender;
/** @type {string} */
marital_status;
/** @type {?string} */
deceased_date;
/** @type {boolean} */
is_donor;
/** @type {boolean} */
is_vendor;
/** @type {boolean} */
is_gp_customer;
/** @type {string} */
crm_student_status;
/** @type {string} */
crm_assigned;
/** @type {string} */
last_registered_term;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
last_changed_by;
/** @type {?string} */
last_changed_date;
/** @type {string} */
addr_last_changed_by;
/** @type {?string} */
addr_last_changed_date;
/** @type {string} */
tax_number;
/** @type {string} */
regent_current_program;
/** @type {string} */
regent_degrees;
}
export class PersonPictureResponse {
/** @param {{responseStatus?:ResponseStatus,imageBase64?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
imageBase64;
}
export class CountriesAndStatesResponse {
/** @param {{country_code?:string,country_name?:string,states?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
country_code;
/** @type {string} */
country_name;
/** @type {{ [index: string]: string; }} */
states;
}
export class PrefixResponse {
/** @param {{prefix_code?:string,prefix_name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
prefix_code;
/** @type {string} */
prefix_name;
}
export class Occupation {
/** @param {{id?:number,code?:string,occupation_name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
code;
/** @type {string} */
occupation_name;
}
export class Denomination {
/** @param {{id?:number,code?:string,denomination_name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
code;
/** @type {string} */
denomination_name;
}
export class Ethnicity {
/** @param {{id?:number,code?:string,ethnicity_name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
code;
/** @type {string} */
ethnicity_name;
}
export class AddressAndBioResponse {
/** @param {{responseStatus?:ResponseStatus,person?:PersonExtendedResponse,picture?:PersonPictureResponse,countriesAndStates?:CountriesAndStatesResponse[],prefixes?:PrefixResponse[],maritalStatuses?:{ [index: string]: string; },occupations?:Occupation[],denominations?:Denomination[],ethnicities?:Ethnicity[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {PersonExtendedResponse} */
person;
/** @type {PersonPictureResponse} */
picture;
/** @type {CountriesAndStatesResponse[]} */
countriesAndStates;
/** @type {PrefixResponse[]} */
prefixes;
/** @type {{ [index: string]: string; }} */
maritalStatuses;
/** @type {Occupation[]} */
occupations;
/** @type {Denomination[]} */
denominations;
/** @type {Ethnicity[]} */
ethnicities;
}
export class AddressAndBioRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript AddressAndBioRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/addressAndBio HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String"}
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"}},"person":{"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,"spouse_regent_id":0,"uuid":"String","regent_login":"String","spouse_rwl":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","override_transcript_name":"String","spouse_name":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","denomination":"String","occupation":"String","ethnicity":"String","gender":"String","marital_status":"String","deceased_date":"0001-01-01T00:00:00.0000000","is_donor":false,"is_vendor":false,"is_gp_customer":false,"crm_student_status":"String","crm_assigned":"String","last_registered_term":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","last_changed_by":"String","last_changed_date":"0001-01-01T00:00:00.0000000","addr_last_changed_by":"String","addr_last_changed_date":"0001-01-01T00:00:00.0000000","tax_number":"String","regent_current_program":"String","regent_degrees":"String"},"picture":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"imageBase64":"String"},"countriesAndStates":[{"country_code":"String","country_name":"String","states":{"String":"String"}}],"prefixes":[{"prefix_code":"String","prefix_name":"String"}],"maritalStatuses":{"String":"String"},"occupations":[{"id":0,"code":"String","occupation_name":"String"}],"denominations":[{"id":0,"code":"String","denomination_name":"String"}],"ethnicities":[{"id":0,"code":"String","ethnicity_name":"String"}]}