REST Interface functions table
- Pedro Jose Sanchez Luling
Support for the REST interface was initially implemented in API version 2.7.25. Since this version all API functions can be invoked via REST.
When invoked via REST, the functions that return an XML structure are automatically converted to JSON format, but some special cases need to be reviewed to ensure that the conversion is correctly done. This problem affects specially to functions that returns arrays of elements.
In general, all functions that return responses that don’t contain arrays will work properly and the JSON response will be as expected. But other functions need to be checked to ensure the validity of the JSON response.
The following table contains a complete list all the API functions.
For each function that has been validated to work properly when invoked through the REST API, the second column shows the API Version in which the operation of the function was approved. If the second column is empty, it means that the JSON response has not been approved yet.
Note that the functions that have not been checked may still work fine, but it is not possible to guarantee the correct operation until reviewed
Function | REST support approved from API |
|---|---|
2.7.28 | |
2.7.28 | |
2.7.28 | |
2.7.32 | |
2.7.28 | |
2.7.28 | |
2.7.26 | |
action_list_case |
|
action_list_patient |
|
action_list_user |
|
activity_optional |
|
admission_create |
|
2.7.28 | |
admission_discharge |
|
admission_get |
|
admission_get_task_calendar |
|
admission_get_task_list |
|
admission_join |
|
2.7.31 | |
2.7.31 | |
2.7.26 | |
admission_referral_list |
|
admission_reject |
|
admission_resume |
|
admission_set |
|
admission_update |
|
alert_delete |
|
2.7.31 | |
alert_post |
|
alert_set_read_mark |
|
alert_subscribe |
|
2.7.32 | |
2.7.32 | |
2.7.32 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3428712449 | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3442573313 | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3428974597 | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3427565610 | 2.7.32 |
associate_accept_case |
|
associate_delete_cases |
|
associate_get |
|
associate_get_case_list |
|
associate_get_contact |
|
associate_get_image |
|
associate_insert_case |
|
associate_search |
|
associate_set_contact |
|
associate_set_image |
|
associate_validate |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/17989905 | 2.7.30 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/17989907 | 2.7.30 |
audit_get |
|
audit_get_XML |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/17989916 | 2.7.30 |
background_logs |
|
call_list_output |
|
case_admission_list |
|
case_delete |
|
case_delete_associates |
|
case_evolution_data |
|
case_evolution_graph |
|
case_evolution_list |
|
2.7.32 | |
case_get_associate_list |
|
case_get_associate_permissions |
|
case_get_contact |
|
case_get_educational_tasks |
|
case_get_emergency_list |
|
case_get_health_profile |
|
case_get_identifier_list |
|
case_get_image |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/653033473 | 2.7.28 |
case_get_preference |
|
case_get_preferences |
|
https://linkcare.atlassian.net/wiki/spaces/DES/pages/1296007416 | 2.7.31 |
case_get_task_calendar |
|
case_get_task_list |
|
case_insert |
|
case_insert_associate |
|
case_list |
|
case_search |
|
case_send_associate_invitation |
|
case_set |
|
case_set_associate_permissions |
|
case_set_associate_relationship |
|
case_set_contact |
|
case_set_emergency_list |
|
case_set_image |
|
case_set_preference |
|
case_set_preferences |
|
case_validate |
|
check_connection |
|
code_search |
|
contact_channel_list |
|
contact_list |
|
contact_search |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/14025083 | 2.7.29 |
dashboard_list |
|
datacode_category_add_datacode |
|
datacode_category_delete |
|
datacode_category_get |
|
datacode_category_insert |
|
datacode_category_remove_datacode |
|
datacode_category_search |
|
datacode_category_set |
|
datacode_delete |
|
datacode_get |
|
datacode_insert |
|
datacode_search |
|
datacode_set |
|
elapsed_list |
|
event_action_list |
|
event_add_comment |
|
event_admission_list |
|
event_call_duration_set |
|
event_close |
|
event_delete |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/647692354 | 2.7.31 |
event_get |
|
event_insert |
|
event_issuer_list |
|
event_list_flagged |
|
event_list_pending |
|
event_open |
|
event_role_list |
|
event_set |
|
event_set |
|
event_set_read_mark |
|
event_team_list |
|
event_type |
|
event_user_list |
|
extraction_action_list |
|
extraction_tasks |
|
form_close |
|
form_delete |
|
2.8.1 | |
form_get_array_summary |
|
form_get_header |
|
form_get_question |
|
form_get_summary |
|
form_insert |
|
form_list |
|
form_open |
|
form_PDF |
|
form_set_all_answers |
|
form_set_answer |
|
formula_exec |
|
formula_parse |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/264175636 | 2.8.1 |
goal_set |
|
identifier_list |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3469148170 | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/54755348 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/525893650 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/653099100 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/94474892 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/96212053 | 2.7.26 |
interoperability_key_create |
|
interoperability_key_delete |
|
interoperability_key_get |
|
interoperability_key_list |
|
interoperability_key_set |
|
2.7.29 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/554500570 | 2.7.26 |
library_action_list |
|
library_action_list |
|
library_activity_delete |
|
library_dashboard |
|
library_form_action_list |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/10190886 | 2.7.32 |
library_form_get_literals |
|
library_form_owner_list |
|
library_form_question_move |
|
library_form_question_order |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/10551298 | 2.7.32 |
library_form_set_literals |
|
library_form_unlock_edit |
|
library_program_action_list |
|
library_program_get_info |
|
library_program_list |
|
library_program_owner_list |
|
library_program_set_authors |
|
library_program_set_code |
|
library_program_set_profile |
|
library_program_set_settings |
|
library_program_set_sponsors |
|
library_program_subscription_list |
|
library_program_task_action_list |
|
library_program_task_delete |
|
library_program_task_get |
|
library_program_task_list |
|
library_program_task_move |
|
2.7.31 | |
library_program_task_set |
|
library_program_task_stage_list |
|
library_program_task_template_move |
|
library_program_task_unlock_edit |
|
library_program_version_list |
|
library_protocol_action_list |
|
library_protocol_get |
|
library_protocol_list |
|
library_protocol_set | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/39125167 | 2.7.32 |
library_report_get_page |
|
library_report_get_preview |
|
library_report_get_section |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/39125164 | 2.7.32 |
library_report_set_section |
|
library_resource_delete |
|
library_resource_get |
|
library_resource_get_stream |
|
library_resource_set |
|
library_resource_upload |
|
lsx_parse |
|
notification_channel_list |
|
object_delete |
|
object_purge |
|
object_restore |
|
object_subscribe |
|
object_unsubscribe |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/14024959 | 2.8.1 |
2.7.32 | |
program_get_invitation |
|
program_get_task_calendar |
|
program_get_task_list |
|
2.8.1 | |
program_search |
|
protocol_delete |
|
protocol_get |
|
protocol_list |
|
protocol_search |
|
qr_get |
|
record_delete |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/68550847 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/68550870 | 2.7.26 |
record_insert |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/68550821 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/68550879 | 2.7.26 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/41156695 | 2.8.1 |
report_refresh |
|
scheduled_task_exec |
|
service_get |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3236626433 | 2.7.32 |
2.7.32 | |
2.7.32 | |
session_get_role_list |
|
2.7.32 | |
2.7.25 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/19628223 | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/19628261 | 2.7.32 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/467402873 | 2.7.32 |
2.7.32 | |
2.7.32 | |
2.7.32 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3204055044 | 2.7.26 |
setting_delete |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/19628491 | 2.8.1 |
setting_set |
|
shared_key_extend |
|
shared_key_process |
|
source_get_url |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/19628509 | 2.8.1 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/17334535 | 2.8.1 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/31654031 | 2.8.1 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/32342175 | 2.8.1 |
subscription_admissions_update |
|
subscription_delete |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/12288038 | 2.7.27 |
subscription_insert |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/128057345 | 2.7.27 |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/11665558 | 2.7.27 |
2.7.31 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/11665567 | 2.7.31 |
subscription_member_set |
|
subscription_set |
|
subscription_suggested_program_list |
|
subscription_suggested_program_remove |
|
subscription_suggested_program_set |
|
subscription_update |
|
synergy_get_data |
|
task_action_list |
|
task_activity_insert |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/41517186 | 2.7.32 |
task_cancel |
|
task_category_list |
|
task_close |
|
task_delete |
|
2.7.31 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/28901385 | 2.8.1 |
task_insert |
|
task_insert_by_task_code |
|
task_list |
|
2.7.31 | |
task_set |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/27263063 | 2.7.27 |
task_user_list |
|
team_action_list |
|
2.7.32 | |
team_event_list |
|
2.7.28 | |
team_get_contact |
|
team_get_image |
|
2.7.32 | |
2.7.28 | |
https://linkcare.atlassian.net/wiki/spaces/WS/pages/3099951131 | 2.7.32 |
team_member_detach |
|
2.7.31 | |
2.7.31 | |
2.7.31 | |
team_member_set |
|
2.7.31 | |
team_search |
|
team_set |
|
team_set_contact |
|
team_set_image |
|
team_subscription_list |
|
team_team_insert |
|
2.7.28 | |
team_user_insert |
|
timezone_list |
|
2.7.31 | |
user_get_contact |
|
user_get_favorites |
|
user_get_identifier_list |
|
user_get_image |
|
user_get_membership_list |
|
user_get_preference |
|
user_get_preferences |
|
user_get_professional_category_list |
|
user_get_professional_role_list |
|
user_get_professional_speciality_list |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/1399455800 | 2.7.25 |
user_get_task_calendar |
|
user_get_task_list |
|
https://linkcare.atlassian.net/wiki/spaces/WS/pages/95975522 | 2.7.31 |
user_insert |
|
user_list |
|
user_merge_contact |
|
user_search |
|
user_set |
|
user_set_contact |
|
user_set_image |
|
user_set_preference |
|
user_set_preferences |
|
user_set_role_list |
|
user_validate |
|
workplan_get |
|
workplan_set |
|