| Required permission: | CreatePerson |
| POST | /person/create |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| first_name | body | string | No | |
| middle_name | body | string | No | |
| last_name | body | string | No | |
| preferred_name | body | string | No | |
| birth_name | body | string | No | |
| prefix | body | string | No | |
| addr1 | body | string | No | |
| addr2 | body | string | No | |
| country | body | string | No | |
| state | body | string | No | |
| city | body | string | No | |
| code | body | string | No | |
| phone_home | body | string | No | |
| phone_cell | body | string | No | |
| phone_bus | body | string | No | |
| body | string | No | ||
| dob | body | DateTime? | No | |
| citizenship | body | string | No | |
| citizenship_other | body | string | No | |
| permanent_resident | body | string | No | |
| denomination | body | string | No | |
| occupation | body | string | No | |
| ethnicity | body | string | No | |
| gender | body | string | No | |
| marital_status | body | string | No | |
| deceased_date | body | DateTime? | No | |
| do_not_queue_for_crm | body | bool | No | |
| authorizing_uuid | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int | No | |
| uuid | form | string | 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/create HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
prefix: String,
addr1: String,
addr2: String,
country: String,
state: String,
city: String,
code: String,
phone_home: String,
phone_cell: String,
phone_bus: String,
email: 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,
do_not_queue_for_crm: False,
authorizing_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,
uuid: String
}