| Required permission: | SyncBioAndAddresses |
| POST | /Sync/Bio |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| regent_id | body | int | No | |
| first_name | body | string | No | |
| last_name | body | string | No | |
| middle_name | body | string | No | |
| preferred_name | body | string | No | |
| birth_name | body | string | No | |
| prefix | body | string | No | |
| current_occupation | body | string | No | |
| dob | body | DateTime? | No | |
| deceased_date | body | DateTime? | No | |
| gender | body | string | No | |
| marital_status | body | string | No | |
| citizenship | body | string | No | |
| citizenship_other | body | string | No | |
| permanent_resident | body | string | No | |
| queued_by_username | body | string | No | |
| queued_by_CRM | body | bool | No | |
| queued_by_RE | body | bool | No | |
| queued_by_REGIS | body | bool | No | |
| queued_by_Sugar | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| successfull | 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 /Sync/Bio HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
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-01,
deceased_date: 0001-01-01,
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/jsv
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
}