regis

<back to all web services

UnauthenticatedPersonsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/UnauthenticatedPersons/{reporting_term}
UnauthenticatedPersonsRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
is_submittedbodyboolNo
is_authorizedbodyboolNo
is_archivedbodyboolNo

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/UnauthenticatedPersons/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"reporting_term":"String","is_submitted":false,"is_authorized":false,"is_archived":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]