regis

<back to all web services

SyncBioRequest

Requires Authentication
Required permission:SyncBioAndAddresses
The following routes are available for this service:
POST/Sync/Bio
SyncBioRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idbodyintNo
first_namebodystringNo
last_namebodystringNo
middle_namebodystringNo
preferred_namebodystringNo
birth_namebodystringNo
prefixbodystringNo
current_occupationbodystringNo
dobbodyDateTime?No
deceased_datebodyDateTime?No
genderbodystringNo
marital_statusbodystringNo
citizenshipbodystringNo
citizenship_otherbodystringNo
permanent_residentbodystringNo
queued_by_usernamebodystringNo
queued_by_CRMbodyboolNo
queued_by_REbodyboolNo
queued_by_REGISbodyboolNo
queued_by_SugarbodyboolNo
SyncBioAndAddressResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
successfullformboolNo

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 /Sync/Bio HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"regent_id":0,"first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","current_occupation":"String","dob":"0001-01-01T00:00:00.0000000","deceased_date":"0001-01-01T00:00:00.0000000","gender":"String","marital_status":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","queued_by_username":"String","queued_by_CRM":false,"queued_by_RE":false,"queued_by_REGIS":false,"queued_by_Sugar":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"}},"successfull":false}