Required role: | REGISUserRole |
POST | /person |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
regent_id | form | int | No | |
ubc_id | form | int? | No | |
uuid | form | string | No | |
regent_login | form | string | No | |
first_name | form | string | No | |
preferred_name | form | string | No | |
middle_name | form | string | No | |
last_name | form | string | No | |
form | string | No | ||
phone_home | form | string | No | |
phone_cell | form | string | No | |
phone_bus | form | string | No | |
addr1 | form | string | No | |
addr2 | form | string | No | |
city | form | string | No | |
state | form | string | No | |
country | form | string | No | |
code | form | string | No | |
citizenship | form | string | No | |
citizenship_other | form | string | No | |
permanent_resident | form | string | No | |
dob | form | DateTime? | No | |
is_student | form | bool | No | |
is_faculty | form | bool | No | |
is_vendor | form | bool | 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 /person HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
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, ubc_id: 0, uuid: String, regent_login: String, first_name: String, preferred_name: String, middle_name: String, last_name: String, email: String, phone_home: String, phone_cell: String, phone_bus: String, addr1: String, addr2: String, city: String, state: String, country: String, code: String, citizenship: String, citizenship_other: String, permanent_resident: String, dob: 0001-01-01, is_student: False, is_faculty: False, is_vendor: False }