| Required role: | REGISUserRole |
| POST | /person/{uuid}/sidebar |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int | No | |
| ubc_id | form | int? | No | |
| regent_login | form | string | No | |
| uuid | form | string | No | |
| first_name | form | string | No | |
| middle_name | form | string | No | |
| last_name | form | string | No | |
| preferred_name | form | string | No | |
| dob | form | DateTime? | No | |
| citizenship | form | string | No | |
| citizenship_other | form | string | No | |
| permanent_resident | form | string | No | |
| addr1 | form | string | No | |
| addr2 | form | string | No | |
| city | form | string | No | |
| state | form | string | No | |
| code | form | string | No | |
| country | form | string | No | |
| form | string | No | ||
| phone_home | form | string | No | |
| phone_cell | form | string | No | |
| phone_bus | form | string | No | |
| imageBase64 | form | string | No | |
| tax_number | form | string | No | |
| programs | form | List<StudentProgramSimpleResponse> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| regent_id | form | int | No | |
| uuid | form | string | No | |
| program_id | form | int | No | |
| program_code | form | string | No | |
| program_name | form | string | No | |
| concentration_code | form | string | No | |
| concentration_name | form | string | No | |
| start_date | form | DateTime? | No | |
| end_date | form | DateTime? | No | |
| catalog | form | string | No | |
| is_active | form | bool | No | |
| is_graduated | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/sidebar HTTP/1.1
Host: data.regent-college.edu
Accept: application/json
Content-Type: application/json
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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,"regent_login":"String","uuid":"String","first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","addr1":"String","addr2":"String","city":"String","state":"String","code":"String","country":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","imageBase64":"String","tax_number":"String","programs":[{"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","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}]}