List an entity's forms
curl --request GET \
--url https://api.eka.care/protocol/workflow/forms \
--header 'auth: <auth>'import requests
url = "https://api.eka.care/protocol/workflow/forms"
headers = {"auth": "<auth>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {auth: '<auth>'}};
fetch('https://api.eka.care/protocol/workflow/forms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.eka.care/protocol/workflow/forms")
.header("auth", "<auth>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/protocol/workflow/forms");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/protocol/workflow/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["auth"] = '<auth>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": [
{
"id": "<string>",
"bid": "<string>",
"entity_type": "ADMISSION",
"entity_id": "<string>",
"patient_id": "<string>",
"kind": "SA",
"form_id": "<string>",
"form_name": "<string>",
"status": "IN_PROGRESS",
"response_id": "<string>",
"response_url": "<string>",
"created_by": {
"oid": "<string>",
"name": "<string>",
"ps": "D",
"s": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_by": {
"oid": "<string>",
"name": "<string>",
"ps": "D",
"s": "<string>"
},
"completed_at": "2023-11-07T05:31:56Z",
"signer": {
"kind": "patient"
},
"closed_note": "<string>",
"closed_by": {
"oid": "<string>",
"name": "<string>",
"ps": "D",
"s": "<string>"
},
"closed_at": "2023-11-07T05:31:56Z"
}
]
}{
"status": "error",
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"status": "error",
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}Forms
List an entity's forms
Newest first, for one entity (entity_type + entity_id).
GET
/
protocol
/
workflow
/
forms
List an entity's forms
curl --request GET \
--url https://api.eka.care/protocol/workflow/forms \
--header 'auth: <auth>'import requests
url = "https://api.eka.care/protocol/workflow/forms"
headers = {"auth": "<auth>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {auth: '<auth>'}};
fetch('https://api.eka.care/protocol/workflow/forms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.eka.care/protocol/workflow/forms")
.header("auth", "<auth>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.eka.care/protocol/workflow/forms");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("auth", "<auth>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
require 'uri'
require 'net/http'
url = URI("https://api.eka.care/protocol/workflow/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["auth"] = '<auth>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": [
{
"id": "<string>",
"bid": "<string>",
"entity_type": "ADMISSION",
"entity_id": "<string>",
"patient_id": "<string>",
"kind": "SA",
"form_id": "<string>",
"form_name": "<string>",
"status": "IN_PROGRESS",
"response_id": "<string>",
"response_url": "<string>",
"created_by": {
"oid": "<string>",
"name": "<string>",
"ps": "D",
"s": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_by": {
"oid": "<string>",
"name": "<string>",
"ps": "D",
"s": "<string>"
},
"completed_at": "2023-11-07T05:31:56Z",
"signer": {
"kind": "patient"
},
"closed_note": "<string>",
"closed_by": {
"oid": "<string>",
"name": "<string>",
"ps": "D",
"s": "<string>"
},
"closed_at": "2023-11-07T05:31:56Z"
}
]
}{
"status": "error",
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"status": "error",
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}Headers
The access token. The gateway verifies it and passes the user and the business on.
Query Parameters
Available options:
ADMISSION, APPOINTMENT, PATIENT, PRESCRIPTION Required string length:
1 - 200Was this page helpful?

