| Required permission: | SearchPerson |
| POST | /person/{uuid}/extended |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int | No | |
| ubc_id | form | int? | No | |
| spouse_regent_id | form | int? | No | |
| uuid | form | string | No | |
| regent_login | form | string | No | |
| spouse_rwl | form | string | No | |
| first_name | form | string | No | |
| middle_name | form | string | No | |
| last_name | form | string | No | |
| preferred_name | form | string | No | |
| birth_name | form | string | No | |
| override_transcript_name | form | string | No | |
| spouse_name | form | string | No | |
| addr1 | form | string | No | |
| addr2 | form | string | No | |
| country | form | string | No | |
| state | form | string | No | |
| city | form | string | No | |
| code | form | string | No | |
| phone_home | form | string | No | |
| phone_cell | form | string | No | |
| phone_bus | form | string | No | |
| form | string | No | ||
| prefix | form | string | No | |
| dob | form | DateTime? | No | |
| citizenship | form | string | No | |
| citizenship_other | form | string | No | |
| permanent_resident | form | string | No | |
| denomination | form | string | No | |
| occupation | form | string | No | |
| ethnicity | form | string | No | |
| gender | form | string | No | |
| marital_status | form | string | No | |
| deceased_date | form | DateTime? | No | |
| is_donor | form | bool | No | |
| is_vendor | form | bool | No | |
| is_gp_customer | form | bool | No | |
| crm_student_status | form | string | No | |
| crm_assigned | form | string | No | |
| last_registered_term | form | string | No | |
| is_regent_staff | form | bool | No | |
| regent_title | form | string | No | |
| regent_department | form | string | No | |
| regent_faculty_profile_url | form | string | No | |
| regent_image_url | form | string | No | |
| include_on_website | form | bool | No | |
| added_by | form | string | No | |
| added_date | form | DateTime? | No | |
| last_changed_by | form | string | No | |
| last_changed_date | form | DateTime? | No | |
| addr_last_changed_by | form | string | No | |
| addr_last_changed_date | form | DateTime? | No | |
| tax_number | form | string | No | |
| regent_current_program | form | string | No | |
| regent_degrees | form | string | No |
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 /person/{uuid}/extended HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
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,
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-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,
is_donor: False,
is_vendor: False,
is_gp_customer: False,
crm_student_status: String,
crm_assigned: String,
last_registered_term: String,
is_regent_staff: False,
regent_title: String,
regent_department: String,
regent_faculty_profile_url: String,
regent_image_url: String,
include_on_website: False,
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,
tax_number: String,
regent_current_program: String,
regent_degrees: String
}