regis

<back to all web services

UnauthenticatedPersonUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/UnauthenticatedPerson/{uuid}/Update
UnauthenticatedPersonUpdateRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
regent_idbodyint?No
is_returningbodyboolNo
is_applyingbodyboolNo
is_landlordbodyboolNo
postsecondary_education_levelbodyintNo
reporting_termbodystringNo
surveybodystringNo
friend_referralbodystringNo
other_referralbodystringNo
first_namebodystringNo
last_namebodystringNo
emailbodystringNo
dobbodyDateTime?No
middle_namebodystringNo
birth_namebodystringNo
preferred_namebodystringNo
prefixbodystringNo
addr1bodystringNo
addr2bodystringNo
countrybodystringNo
country_codebodystringNo
statebodystringNo
citybodystringNo
codebodystringNo
phone_homebodystringNo
genderbodystringNo
denominationbodystringNo
occupationbodystringNo
ethnicitybodystringNo
citizenshipbodystringNo
citizenship_otherbodystringNo
permanent_residentbodystringNo
marital_statusbodystringNo
is_submittedbodyboolNo
UnauthenticatedPersonResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformint?No
reporting_termformstringNo
surveyformstringNo
friend_referralformstringNo
other_referralformstringNo
is_returningformboolNo
is_applyingformboolNo
is_landlordformboolNo
postsecondary_education_levelformintNo
uuidformstringNo
regent_loginformstringNo
first_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
birth_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
added_byformstringNo
added_dateformDateTime?No
last_changed_byformstringNo
last_changed_dateformDateTime?No
addr_last_changed_byformstringNo
addr_last_changed_dateformDateTime?No
timestampformDateTimeNo
submitted_datetimeformDateTime?No
submitted_by_unauthenticated_person_idformint?No
authorized_datetimeformDateTime?No
authorized_by_person_idformint?No
archived_datetimeformDateTime?No
archived_by_person_idformint?No

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

HTTP + CSV

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/csv
Content-Type: text/csv
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-01T00:00:00.0000000","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/csv
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-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","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","timestamp":"0001-01-01T00:00:00.0000000","submitted_datetime":"0001-01-01T00:00:00.0000000","submitted_by_unauthenticated_person_id":0,"authorized_datetime":"0001-01-01T00:00:00.0000000","authorized_by_person_id":0,"archived_datetime":"0001-01-01T00:00:00.0000000","archived_by_person_id":0}