regis

<back to all web services

BioSyncRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/sync
BioSyncRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
BioSyncResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
regent_idformintNo
sugar_bioformBioResponseNo
regis_bioformBioResponseNo
re_bioformBioResponseNo
exists_in_sugarformboolNo
exists_in_reformboolNo
are_equalformboolNo
first_name_are_equalformboolNo
middle_name_are_equalformboolNo
last_name_are_equalformboolNo
preferred_name_are_equalformboolNo
birth_name_are_equalformboolNo
prefix_are_equalformboolNo
dob_are_equalformboolNo
deceased_are_equalformboolNo
citizenship_are_equalformboolNo
gender_are_equalformboolNo
marital_status_are_equalformboolNo
BioResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
first_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
birth_nameformstringNo
prefixformstringNo
dobformDateTime?No
citizenshipformstringNo
citizenship_codeformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
citizenship_other_codeformstringNo
permanent_resident_codeformstringNo
genderformstringNo
gender_codeformstringNo
marital_statusformstringNo
marital_status_codeformstringNo
deceased_dateformDateTime?No
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?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 /admissions/{uuid}/bio/sync HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}

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"}},"uuid":"String","regent_id":0,"sugar_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"regis_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"re_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"exists_in_sugar":false,"exists_in_re":false,"are_equal":false,"first_name_are_equal":false,"middle_name_are_equal":false,"last_name_are_equal":false,"preferred_name_are_equal":false,"birth_name_are_equal":false,"prefix_are_equal":false,"dob_are_equal":false,"deceased_are_equal":false,"citizenship_are_equal":false,"gender_are_equal":false,"marital_status_are_equal":false}