regis

<back to all web services

PersonExtendedRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/{uuid}/extended
PersonExtendedRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
PersonExtendedResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
ubc_idformint?No
spouse_regent_idformint?No
uuidformstringNo
regent_loginformstringNo
spouse_rwlformstringNo
first_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
birth_nameformstringNo
override_transcript_nameformstringNo
spouse_nameformstringNo
addr1formstringNo
addr2formstringNo
countryformstringNo
stateformstringNo
cityformstringNo
codeformstringNo
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
emailformstringNo
prefixformstringNo
dobformDateTime?No
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
denominationformstringNo
occupationformstringNo
ethnicityformstringNo
genderformstringNo
marital_statusformstringNo
deceased_dateformDateTime?No
is_donorformboolNo
is_vendorformboolNo
is_gp_customerformboolNo
crm_student_statusformstringNo
crm_assignedformstringNo
last_registered_termformstringNo
is_regent_staffformboolNo
regent_titleformstringNo
regent_departmentformstringNo
regent_faculty_profile_urlformstringNo
regent_image_urlformstringNo
include_on_websiteformboolNo
added_byformstringNo
added_dateformDateTime?No
last_changed_byformstringNo
last_changed_dateformDateTime?No
addr_last_changed_byformstringNo
addr_last_changed_dateformDateTime?No
tax_numberformstringNo
regent_current_programformstringNo
regent_degreesformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}