regis

<back to all web services

AddressHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/address/history
AddressHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
AddressHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
regent_idformintNo
addressesformList<AddressPhoneEmailResponse>No
AddressPhoneEmailResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformintNo
addressformAddressResponseNo
phoneformPhoneEmailResponseNo
AddressResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
addr1formstringNo
addr2formstringNo
countryformstringNo
country_codeformstringNo
stateformstringNo
cityformstringNo
codeformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No
PhoneEmailResponse Parameters:
NameParameterData TypeRequiredDescription
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
emailformstringNo
start_dateformDateTime?No
end_dateformDateTime?No
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + 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"}}]}