regis

<back to all web services

AddressAndBioUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressandbio/update
AddressAndBioUpdateRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
spouse_regent_idbodyint?No
first_namebodystringNo
middle_namebodystringNo
last_namebodystringNo
preferred_namebodystringNo
birth_namebodystringNo
addr1bodystringNo
addr2bodystringNo
countrybodystringNo
statebodystringNo
citybodystringNo
codebodystringNo
phone_homebodystringNo
phone_cellbodystringNo
phone_busbodystringNo
emailbodystringNo
prefixbodystringNo
dobbodyDateTime?No
citizenshipbodystringNo
citizenship_otherbodystringNo
permanent_residentbodystringNo
denominationbodystringNo
occupationbodystringNo
ethnicitybodystringNo
genderbodystringNo
marital_statusbodystringNo
deceased_datebodyDateTime?No
tax_numberbodystringNo
update_re_and_sugarbodyboolNo
regent_titlebodystringNo
regent_departmentbodystringNo
regent_faculty_profile_urlbodystringNo
regent_image_urlbodystringNo
include_on_websitebodyboolNo
authorizing_uuidbodystringNo
AddressAndBioUpdateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
update_successformboolNo
messagesformList<string>No

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/update HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","spouse_regent_id":0,"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_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","tax_number":"String","update_re_and_sugar":false,"regent_title":"String","regent_department":"String","regent_faculty_profile_url":"String","regent_image_url":"String","include_on_website":false,"authorizing_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"}},"update_success":false,"messages":["String"]}