SOAP / REST API Interfaces
- Pedro Jose Sanchez Luling
SOAP Interface
The API functions have been developed to be invoked via SOAP interface. All API functions are available to be called via SOAP.
WSDL file | https://domain/LINKCARE.wsdl.php |
|---|---|
SOAP Entrypoint | https://domain/ServerWSDL.php |
REST Interface
Implementation of the REST API started in version 2.7.25. Check the documentation of each function to verify if it can be invoked via REST.
REST Entrypoint | https://domain/rest_api/function_name |
|---|---|
Parameter format | application/www-form-urlencoded |
Mode | POST |
The REST support has been implemented In general,. All API functions will respond the an invocation via REST, but the returned response must be checked to validate that it is correct. Most of the functions probably work as expected, but API function that returns list of ITEMS must be reviewed.
As long as the API functions are reviewed, the documentation of each API function will be updated to indicate that the REST API is fully functional.
Take a look at the page REST Interface functions table to see the functions that have been fully checked to work fine when used via the REST interface.
Example
The following example invokes the function user_get_program_list () passing the parameters:
session = “LC62f3b3905c1432.81208736”
user = 2322
Function URL | https://domain/rest_api/user_get_program_list |
|---|---|
Parameters (body) | session=LC62f3b3905c1432.81208736&user=2322 |
Mode | POST |
API Functions response
All API functions return always a response with a similar structure, which consists of the following parts
result: response of the function. The contents depends on the function invoked.
ErrorMsg: Explanation of the error translated to the active session language (if any error occurs during the execution of the function)
ErrorCode: One of the standardized ERROR CODES (if any error occurs during the execution of the function).
server_time: time spent in the execution of the function in milliseconds
XML response format (SOAP interface)
The response generated by the API functions when invoked via SOAP is alway in XML format.
Most of the functions return a structured value, which is enclosed in the result part of the response in XML format. Som functions return only a scalar value.
Structure of the XML response of an API function invoked via SOAP:
<result>function result</result>
<ErrorMsg/>
<ErrorCode/>
<server_time>10</server_time>Example
Example of the response of the API function user_get_program_list ()
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>
<program_list>
<total>
<tasks>
<open>6</pending>
<closed>0</complete>
</tasks>
<events>
<open>0</pending>
<closed>2</complete>
</events>
<alerts>3</alerts>
</total>
<programs>
<program>
<ref>384</ref>
<name>PHYSICAL TELE-COACHING RELIEF</name>
<description>Physical tele-coaching care plan for RELIEF</description>
<image_info/>
<tasks>
<open>6</pending>
<closed>0</complete>
</tasks>
<events>
<open>0</pending>
<closed>2</complete>
</events>
<teams>
<team>
<ref>1</ref>
<name>Linkcare</name>
</team>
<team>
<ref>24</ref>
<name>Hospital de niños</name>
</team>
</teams>
</program>
</programs>
</program_list>
</result>
<ErrorMsg/>
<ErrorCode/>
<server_time>10</server_time>REST Interface
Most of the functions return a structured value, which is enclosed in the result part of the response in JSON format. Some functions return only a scalar value.
Structure of the JSON response of an API function invoked via SOAP
{
"result": "",
"ErrorMsg": "",
"ErrorCode": null,
"server_time": 3688.5
}Example
Example of the response of the API function user_get_program_list ()
{
"result": {
"total": {
"tasks": {
"open": 6,
"closed": 0
},
"events": {
"open": 0,
"closed": 2,
"flagged": 0
},
"alerts": 3
},
"programs": [
{
"ref": 384,
"code": "HDOM",
"name": "PHYSICAL TELE-COACHING RELIEF",
"description": "Physical tele-coaching care plan for RELIEF",
"image_info": "",
"tasks": {
"open": 6,
"closed": 0
},
"events": {
"open": 0,
"closed": 2,
"flagged": 0
},
"teams": [
{
"ref": 1,
"name": "Linkcare"
},
{
"ref": 24,
"name": "Hospital de niños"
}
]
} }
]
},
"ErrorMsg": "",
"ErrorCode": ""
}