| Required role: | REGISUserRole |
| POST | /Registration/UnauthenticatedPerson/{uuid}/Update |
|---|
"use strict";
export class UnauthenticatedPersonResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,reporting_term?:string,survey?:string,friend_referral?:string,other_referral?:string,is_returning?:boolean,is_applying?:boolean,is_landlord?:boolean,postsecondary_education_level?:number,uuid?:string,regent_login?:string,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,birth_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,added_by?:string,added_date?:string,last_changed_by?:string,last_changed_date?:string,addr_last_changed_by?:string,addr_last_changed_date?:string,timestamp?:string,submitted_datetime?:string,submitted_by_unauthenticated_person_id?:number,authorized_datetime?:string,authorized_by_person_id?:number,archived_datetime?:string,archived_by_person_id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {?number} */
regent_id;
/** @type {string} */
reporting_term;
/** @type {string} */
survey;
/** @type {string} */
friend_referral;
/** @type {string} */
other_referral;
/** @type {boolean} */
is_returning;
/** @type {boolean} */
is_applying;
/** @type {boolean} */
is_landlord;
/** @type {number} */
postsecondary_education_level;
/** @type {string} */
uuid;
/** @type {string} */
regent_login;
/** @type {string} */
first_name;
/** @type {string} */
middle_name;
/** @type {string} */
last_name;
/** @type {string} */
preferred_name;
/** @type {string} */
birth_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 {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} */
timestamp;
/** @type {?string} */
submitted_datetime;
/** @type {?number} */
submitted_by_unauthenticated_person_id;
/** @type {?string} */
authorized_datetime;
/** @type {?number} */
authorized_by_person_id;
/** @type {?string} */
archived_datetime;
/** @type {?number} */
archived_by_person_id;
}
export class UnauthenticatedPersonUpdateRequest {
/** @param {{uuid?:string,regent_id?:number,is_returning?:boolean,is_applying?:boolean,is_landlord?:boolean,postsecondary_education_level?:number,reporting_term?:string,survey?:string,friend_referral?:string,other_referral?:string,first_name?:string,last_name?:string,email?:string,dob?:string,middle_name?:string,birth_name?:string,preferred_name?:string,prefix?:string,addr1?:string,addr2?:string,country?:string,country_code?:string,state?:string,city?:string,code?:string,phone_home?:string,gender?:string,denomination?:string,occupation?:string,ethnicity?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,marital_status?:string,is_submitted?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {?number} */
regent_id;
/** @type {boolean} */
is_returning;
/** @type {boolean} */
is_applying;
/** @type {boolean} */
is_landlord;
/** @type {number} */
postsecondary_education_level;
/** @type {string} */
reporting_term;
/** @type {string} */
survey;
/** @type {string} */
friend_referral;
/** @type {string} */
other_referral;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
email;
/** @type {?string} */
dob;
/** @type {string} */
middle_name;
/** @type {string} */
birth_name;
/** @type {string} */
preferred_name;
/** @type {string} */
prefix;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
country;
/** @type {string} */
country_code;
/** @type {string} */
state;
/** @type {string} */
city;
/** @type {string} */
code;
/** @type {string} */
phone_home;
/** @type {string} */
gender;
/** @type {string} */
denomination;
/** @type {string} */
occupation;
/** @type {string} */
ethnicity;
/** @type {string} */
citizenship;
/** @type {string} */
citizenship_other;
/** @type {string} */
permanent_resident;
/** @type {string} */
marital_status;
/** @type {boolean} */
is_submitted;
}
JavaScript UnauthenticatedPersonUpdateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/UnauthenticatedPerson/{uuid}/Update HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
regent_id: 0,
is_returning: False,
is_applying: False,
is_landlord: False,
postsecondary_education_level: 0,
reporting_term: String,
survey: String,
friend_referral: String,
other_referral: String,
first_name: String,
last_name: String,
email: String,
dob: 0001-01-01,
middle_name: String,
birth_name: String,
preferred_name: String,
prefix: String,
addr1: String,
addr2: String,
country: String,
country_code: String,
state: String,
city: String,
code: String,
phone_home: String,
gender: String,
denomination: String,
occupation: String,
ethnicity: String,
citizenship: String,
citizenship_other: String,
permanent_resident: String,
marital_status: String,
is_submitted: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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,
reporting_term: String,
survey: String,
friend_referral: String,
other_referral: String,
is_returning: False,
is_applying: False,
is_landlord: False,
postsecondary_education_level: 0,
uuid: String,
regent_login: String,
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_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-01,
citizenship: String,
citizenship_other: String,
permanent_resident: String,
denomination: String,
occupation: String,
ethnicity: String,
gender: String,
marital_status: String,
deceased_date: 0001-01-01,
added_by: String,
added_date: 0001-01-01,
last_changed_by: String,
last_changed_date: 0001-01-01,
addr_last_changed_by: String,
addr_last_changed_date: 0001-01-01,
timestamp: 0001-01-01,
submitted_datetime: 0001-01-01,
submitted_by_unauthenticated_person_id: 0,
authorized_datetime: 0001-01-01,
authorized_by_person_id: 0,
archived_datetime: 0001-01-01,
archived_by_person_id: 0
}