Required role: | REGISUserRole |
POST | /admissions/{uuid}/address/history |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
uuid | form | string | No | |
regent_id | form | int | No | |
addresses | form | List<AddressPhoneEmailResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | form | string | No | |
regent_id | form | int | No | |
address | form | AddressResponse | No | |
phone | form | PhoneEmailResponse | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
addr1 | form | string | No | |
addr2 | form | string | No | |
country | form | string | No | |
country_code | form | string | No | |
state | form | string | No | |
city | form | string | No | |
code | form | string | No | |
start_date | form | DateTime? | No | |
end_date | form | DateTime? | No | |
added_by | form | string | No | |
added_date | form | DateTime? | No | |
changed_by | form | string | No | |
changed_date | form | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
phone_home | form | string | No | |
phone_cell | form | string | No | |
phone_bus | form | string | No | |
form | string | No | ||
start_date | form | DateTime? | No | |
end_date | form | DateTime? | No | |
added_by | form | string | No | |
added_date | form | DateTime? | No | |
changed_by | form | string | No | |
changed_date | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /admissions/{uuid}/address/history HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"addresses":[{"uuid":"String","regent_id":0,"address":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"addr1":"String","addr2":"String","country":"String","country_code":"String","state":"String","city":"String","code":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"phone":{"phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}}]}