Required role: | REGISUserRole |
POST | /Registration/UnauthenticatedPerson |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
first_name | body | string | No | |
last_name | body | string | No | |
reporting_term | body | string | No | |
body | string | No | ||
dob | body | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
regent_id | form | int? | No | |
reporting_term | form | string | No | |
survey | form | string | No | |
friend_referral | form | string | No | |
other_referral | form | string | No | |
is_returning | form | bool | No | |
is_applying | form | bool | No | |
is_landlord | form | bool | No | |
postsecondary_education_level | form | int | No | |
uuid | form | string | No | |
regent_login | form | string | No | |
first_name | form | string | No | |
middle_name | form | string | No | |
last_name | form | string | No | |
preferred_name | form | string | No | |
birth_name | form | string | No | |
spouse_name | form | string | No | |
addr1 | form | string | No | |
addr2 | form | string | No | |
country | form | string | No | |
state | form | string | No | |
city | form | string | No | |
code | form | string | No | |
phone_home | form | string | No | |
phone_cell | form | string | No | |
phone_bus | form | string | No | |
form | string | No | ||
prefix | form | string | No | |
dob | form | DateTime? | No | |
citizenship | form | string | No | |
citizenship_other | form | string | No | |
permanent_resident | form | string | No | |
denomination | form | string | No | |
occupation | form | string | No | |
ethnicity | form | string | No | |
gender | form | string | No | |
marital_status | form | string | No | |
deceased_date | form | DateTime? | No | |
added_by | form | string | No | |
added_date | form | DateTime? | No | |
last_changed_by | form | string | No | |
last_changed_date | form | DateTime? | No | |
addr_last_changed_by | form | string | No | |
addr_last_changed_date | form | DateTime? | No | |
timestamp | form | DateTime | No | |
submitted_datetime | form | DateTime? | No | |
submitted_by_unauthenticated_person_id | form | int? | No | |
authorized_datetime | form | DateTime? | No | |
authorized_by_person_id | form | int? | No | |
archived_datetime | form | DateTime? | No | |
archived_by_person_id | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/UnauthenticatedPerson HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
first_name: String,
last_name: String,
reporting_term: String,
email: String,
dob: 0001-01-01
}
HTTP/1.1 200 OK Content-Type: text/jsv 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-01, citizenship: String, citizenship_other: String, permanent_resident: String, denomination: String, occupation: String, ethnicity: String, gender: String, marital_status: String, deceased_date: 0001-01-01, added_by: String, added_date: 0001-01-01, last_changed_by: String, last_changed_date: 0001-01-01, addr_last_changed_by: String, addr_last_changed_date: 0001-01-01, timestamp: 0001-01-01, submitted_datetime: 0001-01-01, submitted_by_unauthenticated_person_id: 0, authorized_datetime: 0001-01-01, authorized_by_person_id: 0, archived_datetime: 0001-01-01, archived_by_person_id: 0 }