regis

<back to all web services

AddressAndBioRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressAndBio
AddressAndBioRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
AddressAndBioResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
personformPersonExtendedResponseNo
pictureformPersonPictureResponseNo
countriesAndStatesformList<CountriesAndStatesResponse>No
prefixesformList<PrefixResponse>No
maritalStatusesformDictionary<string, string>No
occupationsformList<Occupation>No
denominationsformList<Denomination>No
ethnicitiesformList<Ethnicity>No
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
PersonPictureResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
imageBase64formstringNo
CountriesAndStatesResponse Parameters:
NameParameterData TypeRequiredDescription
country_codeformstringNo
country_nameformstringNo
statesformDictionary<string, string>No
PrefixResponse Parameters:
NameParameterData TypeRequiredDescription
prefix_codeformstringNo
prefix_nameformstringNo
Occupation Parameters:
NameParameterData TypeRequiredDescription
idformintNo
codeformstringNo
occupation_nameformstringNo
Denomination Parameters:
NameParameterData TypeRequiredDescription
idformintNo
codeformstringNo
denomination_nameformstringNo
Ethnicity Parameters:
NameParameterData TypeRequiredDescription
idformintNo
codeformstringNo
ethnicity_nameformstringNo

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

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"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"}},"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","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-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"}]}