Awell Health Developer Hub
Developer Hub

Request

Endpoint

GET/v1/calculations

Response

HTTP 200

When successful, the API will return a HTTP status code of 200 and in the response an array of calculations. The schema of the response can be found here.

Below you can find an example of a truncated response:

  • json
01[
02 {
03 "calculation_id": "bmi",
04 "calculation_name": {
05 "en": "BMI (metric)"
06 },
07 "calculation_description": {
08 "en": "<h1 id=\"bodymassindexbmi\">Body Mass Index (BMI)</h1>..."
09 },
10 "calculation_blueprint": {
11 "input_definition": [
12 {
13 "id": "height",
14 "label": {
15 "nl": "Lengte",
16 "en": "Height",
17 "fr": "Longueur",
18 "de": "Länge"
19 },
20 "input_type": {
21 "type": "number",
22 "range": {
23 "min": {
24 "value": 20
25 },
26 "max": {
27 "value": 300
28 }
29 }
30 },
31 "format": "cm"
32 },
33 {
34 "id": "weight",
35 "label": {
36 "nl": "Gewicht",
37 "en": "Weight",
38 "fr": "Poids",
39 "de": "Gewicht"
40 },
41 "input_type": {
42 "type": "number",
43 "range": {
44 "min": {
45 "value": 10
46 },
47 "max": {
48 "value": 300
49 }
50 }
51 },
52 "format": "kg"
53 }
54 ],
55 "output_definition": [
56 {
57 "subresult_id": "BMI",
58 "label": {
59 "en": "Body Mass Index"
60 },
61 "unit": {
62 "en": "kg/m2"
63 },
64 "type": "number"
65 }
66 ]
67 },
68 "is_private": false
69 },
70 ...
71]

HTTP 500

When unsuccessful, the API will return a 500 HTTP status.