REST API

v1.0.7

We provide an HTTP REST API to allow clients to manage patients, patient sessions and room/sensor/department data. All endpoints of this API can be called using the access token generated by the client ID-secret pair. Please see the Authentication guide to learn more about how to generate the access token.

Patient-related endpoints

Find sensor by reference key

GEThttp://localhost:20001/api/v1/sensors/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

type*nullable enum

Sensor type.

Example: "RGB_CAMERA"

RGB_CAMERATHERMAL_CAMERA

url*string

RTSP URL without any credentials

Example: "rtsp://camera_ip1/Stream/101/"

usernamenullable string

Sensor username.

Example: "cam_user"

passwordnullable string

Write-only sensor credential/password.

Example: "tops3cret"

width*integer (int32)

Width.

Example: 1920

height*integer (int32)

Height.

Example: 1080

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/sensors/{referenceKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "referenceKey": "1",
  "type": "RGB_CAMERA",
  "url": "rtsp://camera_ip1/Stream/101/",
  "username": "cam_user",
  "password": "tops3cret",
  "width": 1920,
  "height": 1080
}

Update sensor

PUThttp://localhost:20001/api/v1/sensors/{referenceKey}

Path parameters

referenceKey*string

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

type*nullable enum

Sensor type.

Example: "RGB_CAMERA"

RGB_CAMERATHERMAL_CAMERA

url*string

RTSP URL without any credentials

Example: "rtsp://camera_ip1/Stream/101/"

usernamenullable string

Sensor username.

Example: "cam_user"

passwordnullable string

Write-only sensor credential/password.

Example: "tops3cret"

width*integer (int32)

Width.

Example: 1920

height*integer (int32)

Height.

Example: 1080

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/sensors/{referenceKey}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "height": 1080,
      "referenceKey": "1",
      "type": "RGB_CAMERA",
      "url": "rtsp://camera_ip1/Stream/101/",
      "width": 1920
    }),
});
const data = await response.json();

Delete sensor by reference key

DELETEhttp://localhost:20001/api/v1/sensors/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/sensors/{referenceKey}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update sensor with only changed fields. This is useful for updating the record without any credential change.

PATCHhttp://localhost:20001/api/v1/sensors/{referenceKey}

Path parameters

referenceKey*string

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

type*nullable enum

Sensor type.

Example: "RGB_CAMERA"

RGB_CAMERATHERMAL_CAMERA

url*string

RTSP URL without any credentials

Example: "rtsp://camera_ip1/Stream/101/"

usernamenullable string

Sensor username.

Example: "cam_user"

passwordnullable string

Write-only sensor credential/password.

Example: "tops3cret"

width*integer (int32)

Width.

Example: 1920

height*integer (int32)

Height.

Example: 1080

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/sensors/{referenceKey}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "height": 1080,
      "referenceKey": "1",
      "type": "RGB_CAMERA",
      "url": "rtsp://camera_ip1/Stream/101/",
      "width": 1920
    }),
});
const data = await response.json();

Find room by reference key

GEThttp://localhost:20001/api/v1/rooms/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

roomNumber*string

Alphanumeric room number value.

floornullable string

Alphanumeric floor value.

departmentDepartmentDTO (object)

sensorSensorDTO (object)

Related sensor / camera

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/rooms/{referenceKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "referenceKey": "1",
  "roomNumber": "text",
  "floor": "N/A",
  "department": {
    "referenceKey": "1",
    "name": "Cardiology"
  },
  "sensor": {
    "referenceKey": "1",
    "type": "RGB_CAMERA",
    "url": "rtsp://camera_ip1/Stream/101/",
    "username": "cam_user",
    "password": "tops3cret",
    "width": 1920,
    "height": 1080
  }
}

Update room

PUThttp://localhost:20001/api/v1/rooms/{referenceKey}

Path parameters

referenceKey*string

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

roomNumber*string

Alphanumeric room number value.

floornullable string

Alphanumeric floor value.

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/rooms/{referenceKey}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "referenceKey": "1",
      "roomNumber": "text"
    }),
});
const data = await response.json();

Delete room by reference key

DELETEhttp://localhost:20001/api/v1/rooms/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/rooms/{referenceKey}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns all patients in the hospital

GEThttp://localhost:20001/api/v1/patients/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Name.

Example: "Tom"

surname*string

Surname.

Example: "Hanks"

dateOfBirth*string (date)

Date of birth in ISO-8601 format (yyyy-MM-dd)

Example: "1990-06-12"

wanderRisknullable boolean

Wander risk flag (Setting this flag true enables wander risk notifications).

fallRisknullable boolean

Fall risk. (Setting this flag true enables fall risk notifications).

medicalIdnullable string

Medical identifier of the patient specific to the hospital.

Example: "DM1-INSULIN DNR SCD"

mobilityTargetnullable integer (int32)

Daily mobility target in minutes

Example: 90

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{referenceKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "referenceKey": "1",
  "name": "Tom",
  "surname": "Hanks",
  "dateOfBirth": "1990-06-12",
  "wanderRisk": false,
  "fallRisk": false,
  "medicalId": "DM1-INSULIN DNR SCD",
  "mobilityTarget": 90
}

Update patient

PUThttp://localhost:20001/api/v1/patients/{referenceKey}

Path parameters

referenceKey*string

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Name.

Example: "Tom"

surname*string

Surname.

Example: "Hanks"

dateOfBirth*string (date)

Date of birth in ISO-8601 format (yyyy-MM-dd)

Example: "1990-06-12"

wanderRisknullable boolean

Wander risk flag (Setting this flag true enables wander risk notifications).

fallRisknullable boolean

Fall risk. (Setting this flag true enables fall risk notifications).

medicalIdnullable string

Medical identifier of the patient specific to the hospital.

Example: "DM1-INSULIN DNR SCD"

mobilityTargetnullable integer (int32)

Daily mobility target in minutes

Example: 90

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{referenceKey}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "dateOfBirth": "1990-06-12",
      "name": "Tom",
      "referenceKey": "1",
      "surname": "Hanks"
    }),
});
const data = await response.json();

Delete patient by reference key

DELETEhttp://localhost:20001/api/v1/patients/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{referenceKey}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Find department by reference key

GEThttp://localhost:20001/api/v1/departments/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Department name.

Example: "Cardiology"

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/departments/{referenceKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "referenceKey": "1",
  "name": "Cardiology"
}

Update department

PUThttp://localhost:20001/api/v1/departments/{referenceKey}

Path parameters

referenceKey*string

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Department name.

Example: "Cardiology"

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/departments/{referenceKey}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Cardiology",
      "referenceKey": "1"
    }),
});
const data = await response.json();

Delete department by reference key

DELETEhttp://localhost:20001/api/v1/departments/{referenceKey}

Path parameters

referenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/departments/{referenceKey}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Find all sensors

GEThttp://localhost:20001/api/v1/sensors

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

type*nullable enum

Sensor type.

Example: "RGB_CAMERA"

RGB_CAMERATHERMAL_CAMERA

url*string

RTSP URL without any credentials

Example: "rtsp://camera_ip1/Stream/101/"

usernamenullable string

Sensor username.

Example: "cam_user"

passwordnullable string

Write-only sensor credential/password.

Example: "tops3cret"

width*integer (int32)

Width.

Example: 1920

height*integer (int32)

Height.

Example: 1080

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/sensors', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "referenceKey": "1",
    "type": "RGB_CAMERA",
    "url": "rtsp://camera_ip1/Stream/101/",
    "username": "cam_user",
    "password": "tops3cret",
    "width": 1920,
    "height": 1080
  }
]

Create sensor

POSThttp://localhost:20001/api/v1/sensors

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

type*nullable enum

Sensor type.

Example: "RGB_CAMERA"

RGB_CAMERATHERMAL_CAMERA

url*string

RTSP URL without any credentials

Example: "rtsp://camera_ip1/Stream/101/"

usernamenullable string

Sensor username.

Example: "cam_user"

passwordnullable string

Write-only sensor credential/password.

Example: "tops3cret"

width*integer (int32)

Width.

Example: 1920

height*integer (int32)

Height.

Example: 1080

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/sensors', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "height": 1080,
      "referenceKey": "1",
      "type": "RGB_CAMERA",
      "url": "rtsp://camera_ip1/Stream/101/",
      "width": 1920
    }),
});
const data = await response.json();

Find all rooms

GEThttp://localhost:20001/api/v1/rooms

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

roomNumber*string

Alphanumeric room number value.

floornullable string

Alphanumeric floor value.

departmentDepartmentDTO (object)

sensorSensorDTO (object)

Related sensor / camera

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/rooms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "referenceKey": "1",
    "roomNumber": "text",
    "floor": "N/A",
    "department": {
      "referenceKey": "1",
      "name": "Cardiology"
    },
    "sensor": {
      "referenceKey": "1",
      "type": "RGB_CAMERA",
      "url": "rtsp://camera_ip1/Stream/101/",
      "username": "cam_user",
      "password": "tops3cret",
      "width": 1920,
      "height": 1080
    }
  }
]

Create room

POSThttp://localhost:20001/api/v1/rooms

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

roomNumber*string

Alphanumeric room number value.

floornullable string

Alphanumeric floor value.

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/rooms', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "referenceKey": "1",
      "roomNumber": "text"
    }),
});
const data = await response.json();

Returns all patients in the hospital

GEThttp://localhost:20001/api/v1/patients

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Name.

Example: "Tom"

surname*string

Surname.

Example: "Hanks"

dateOfBirth*string (date)

Date of birth in ISO-8601 format (yyyy-MM-dd)

Example: "1990-06-12"

wanderRisknullable boolean

Wander risk flag (Setting this flag true enables wander risk notifications).

fallRisknullable boolean

Fall risk. (Setting this flag true enables fall risk notifications).

medicalIdnullable string

Medical identifier of the patient specific to the hospital.

Example: "DM1-INSULIN DNR SCD"

mobilityTargetnullable integer (int32)

Daily mobility target in minutes

Example: 90

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "referenceKey": "1",
    "name": "Tom",
    "surname": "Hanks",
    "dateOfBirth": "1990-06-12",
    "wanderRisk": false,
    "fallRisk": false,
    "medicalId": "DM1-INSULIN DNR SCD",
    "mobilityTarget": 90
  }
]

Create patient

POSThttp://localhost:20001/api/v1/patients

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Name.

Example: "Tom"

surname*string

Surname.

Example: "Hanks"

dateOfBirth*string (date)

Date of birth in ISO-8601 format (yyyy-MM-dd)

Example: "1990-06-12"

wanderRisknullable boolean

Wander risk flag (Setting this flag true enables wander risk notifications).

fallRisknullable boolean

Fall risk. (Setting this flag true enables fall risk notifications).

medicalIdnullable string

Medical identifier of the patient specific to the hospital.

Example: "DM1-INSULIN DNR SCD"

mobilityTargetnullable integer (int32)

Daily mobility target in minutes

Example: 90

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "dateOfBirth": "1990-06-12",
      "name": "Tom",
      "referenceKey": "1",
      "surname": "Hanks"
    }),
});
const data = await response.json();

Find all active patient sessions

GEThttp://localhost:20001/api/v1/patient-sessions

Response

200400403404500

OK

Body

*/*

referenceKeynullable string

A unique identifier (UUID) for the patient session. (This can be used for any subsequent endpoint call)

Example: "363d557d-ef14-4c4f-a39f-c3c130f47100"

standbynullable boolean

Standby flag

patient*PatientDTO (object)

room*RoomDTO (object)

Related room

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "referenceKey": "363d557d-ef14-4c4f-a39f-c3c130f47100",
    "standby": false,
    "patient": {
      "referenceKey": "1",
      "name": "Tom",
      "surname": "Hanks",
      "dateOfBirth": "1990-06-12",
      "wanderRisk": false,
      "fallRisk": false,
      "medicalId": "DM1-INSULIN DNR SCD",
      "mobilityTarget": 90
    },
    "room": {
      "referenceKey": "1",
      "roomNumber": "text",
      "floor": "N/A",
      "department": {
        "referenceKey": "1",
        "name": "Cardiology"
      },
      "sensor": {
        "referenceKey": "1",
        "type": "RGB_CAMERA",
        "url": "rtsp://camera_ip1/Stream/101/",
        "username": "cam_user",
        "password": "tops3cret",
        "width": 1920,
        "height": 1080
      }
    }
  }
]

Creates/starts a patient session. This will also create related department, room, sensor & patient data if necessary.

POSThttp://localhost:20001/api/v1/patient-sessions

Body

application/json

referenceKeynullable string

A unique identifier (UUID) for the patient session. (This can be used for any subsequent endpoint call)

Example: "363d557d-ef14-4c4f-a39f-c3c130f47100"

standbynullable boolean

Standby flag

patient*PatientDTO (object)

room*RoomDTO (object)

Related room

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "patient": {
        "dateOfBirth": "1990-06-12",
        "name": "Tom",
        "referenceKey": "1",
        "surname": "Hanks"
      },
      "room": {
        "referenceKey": "1",
        "roomNumber": "text"
      }
    }),
});
const data = await response.json();

Find all departments

GEThttp://localhost:20001/api/v1/departments

Response

200400403404500

OK

Body

*/*

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Department name.

Example: "Cardiology"

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/departments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "referenceKey": "1",
    "name": "Cardiology"
  }
]

Create department

POSThttp://localhost:20001/api/v1/departments

Body

application/json

referenceKey*string

A unique identifier (UUID) which should be generated by the owner of the DTO.

Example: "1"

name*string

Department name.

Example: "Cardiology"

Response

200400403404500

OK

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/departments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Cardiology",
      "referenceKey": "1"
    }),
});
const data = await response.json();

Makes a patient leave the room

PATCHhttp://localhost:20001/api/v1/patients/{referenceKey}/leave

Path parameters

referenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{referenceKey}/leave', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Discharges a patient

PATCHhttp://localhost:20001/api/v1/patients/{referenceKey}/discharge

Path parameters

referenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{referenceKey}/discharge', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Transfers a patient to another room.

PATCHhttp://localhost:20001/api/v1/patients/{patientReferenceKey}/transfer/{roomReferenceKey}

Path parameters

patientReferenceKey*string

roomReferenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{patientReferenceKey}/transfer/{roomReferenceKey}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Admits a patient to a room.

PATCHhttp://localhost:20001/api/v1/patients/{patientReferenceKey}/admit/{roomReferenceKey}

Path parameters

patientReferenceKey*string

roomReferenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patients/{patientReferenceKey}/admit/{roomReferenceKey}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Puts a patient's session on standby (No further patient-related data is processed when standby is active).

PATCHhttp://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}/session-standby

Path parameters

sessionReferenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}/session-standby', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Resumes a patient's session.

PATCHhttp://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}/session-resume

Path parameters

sessionReferenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}/session-resume', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Get an active patient session by its reference key

GEThttp://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}

Path parameters

sessionReferenceKey*string

Response

200400403404500

OK

Body

*/*

referenceKeynullable string

A unique identifier (UUID) for the patient session. (This can be used for any subsequent endpoint call)

Example: "363d557d-ef14-4c4f-a39f-c3c130f47100"

standbynullable boolean

Standby flag

patient*PatientDTO (object)

room*RoomDTO (object)

Related room

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "referenceKey": "363d557d-ef14-4c4f-a39f-c3c130f47100",
  "standby": false,
  "patient": {
    "referenceKey": "1",
    "name": "Tom",
    "surname": "Hanks",
    "dateOfBirth": "1990-06-12",
    "wanderRisk": false,
    "fallRisk": false,
    "medicalId": "DM1-INSULIN DNR SCD",
    "mobilityTarget": 90
  },
  "room": {
    "referenceKey": "1",
    "roomNumber": "text",
    "floor": "N/A",
    "department": {
      "referenceKey": "1",
      "name": "Cardiology"
    },
    "sensor": {
      "referenceKey": "1",
      "type": "RGB_CAMERA",
      "url": "rtsp://camera_ip1/Stream/101/",
      "username": "cam_user",
      "password": "tops3cret",
      "width": 1920,
      "height": 1080
    }
  }
}

Ends an ongoing patient session. This doesn't delete related department, room, sensor & patient data

DELETEhttp://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}

Path parameters

sessionReferenceKey*string

Response

200400403404500

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions/{sessionReferenceKey}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get an active patient session by its related patient reference key

GEThttp://localhost:20001/api/v1/patient-sessions/patient/{patientReferenceKey}

Path parameters

patientReferenceKey*string

Response

200400403404500

OK

Body

*/*

referenceKeynullable string

A unique identifier (UUID) for the patient session. (This can be used for any subsequent endpoint call)

Example: "363d557d-ef14-4c4f-a39f-c3c130f47100"

standbynullable boolean

Standby flag

patient*PatientDTO (object)

room*RoomDTO (object)

Related room

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/patient-sessions/patient/{patientReferenceKey}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "referenceKey": "363d557d-ef14-4c4f-a39f-c3c130f47100",
  "standby": false,
  "patient": {
    "referenceKey": "1",
    "name": "Tom",
    "surname": "Hanks",
    "dateOfBirth": "1990-06-12",
    "wanderRisk": false,
    "fallRisk": false,
    "medicalId": "DM1-INSULIN DNR SCD",
    "mobilityTarget": 90
  },
  "room": {
    "referenceKey": "1",
    "roomNumber": "text",
    "floor": "N/A",
    "department": {
      "referenceKey": "1",
      "name": "Cardiology"
    },
    "sensor": {
      "referenceKey": "1",
      "type": "RGB_CAMERA",
      "url": "rtsp://camera_ip1/Stream/101/",
      "username": "cam_user",
      "password": "tops3cret",
      "width": 1920,
      "height": 1080
    }
  }
}

Notification-related endpoints

Reverts a resolved notification.

PATCHhttp://localhost:20001/api/v1/notifications/{notificationReferenceKey}/unresolve

Path parameters

notificationReferenceKey*string

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/notifications/{notificationReferenceKey}/unresolve', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Resolves a notification.

PATCHhttp://localhost:20001/api/v1/notifications/{notificationReferenceKey}/resolve

Path parameters

notificationReferenceKey*string

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('http://localhost:20001/api/v1/notifications/{notificationReferenceKey}/resolve', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();