Cube Integration API

2.9.2
June 24, 2021
Added

Added ALIS app key

2.9.1
January 25, 2021
Fixed

Remove logging call to reduce Sentry usage

Fixed

Add ability to specify if an endpoint should provide cache-control header.

Fixed

User endpoints now send cache-control.

2.9.0
December 9, 2020
Added

Support for iOS APNs push notifications

2.8.15
October 21, 2020
Added

Moved logging to /var/log/cube-api/

2.8.14
October 1, 2020
Fixed

Handle Incident close correctly.

2.8.13
August 26, 2020
Added

Nxtgen integration

Added

Messaging endpoint

Added

extra_json field for users

Fixed

GroupNameManager now creates notification chain correctly.

2.8.12
June 18, 2020
Fixed

Fix for license counting for auth on PHP 7.

2.8.11
May 28, 2020
Added

alarm now returns the incident that it created.

Added

POST account will now update RCM user.

Fixed

Add rcare2 to database

2.8.10
March 26, 2020
Added

Added hash logic to /account to support client side caching.

2.8.9
February 14, 2020
Added

Added new ids param to limit GET /device by device id(s).

Added

Return timezone with cube settings.

Fixed

Update support server IP.

2.8.8
December 3, 2019
Added

Added new rcm_apn_legacy_mode setting to PUT /api/settings

Added

Added script for creating build environment

Added

Updated documentation

2.8.7
November 12, 2019
Added

Added /api/settings/extapp endpoint for pulling RCare Mobil external app config

Added

Added PUT /api/settings for allowing editing of select settings

Added

Changed POST /api/token/wakeup/[user] default behavior to send standard wakeups

Added

Added POST /api/token/wakeup/[user] parameter voip=true to allow for VoIP wakeups

Added

Added apn_topic field to all token endpoints to differentiate between VoIP and iOS tokens

Added

Added notify topics of user_login and user_logout when creating auth log items for rcm-client-ios devices

2.8.6
August 8, 2019
Added

Added support for Debian 10 (buster)

Added

Added extended statuses on LED 4

Fixed

Fixed README documentation

Fixed

Added unit tests to ensure update checks for rcm-client / rcm-client-android behave correctly

2.8.5
July 10, 2019
Added

Added support for KORE failover on LED 4

Fixed

Fixed issue with class const not working on PHP less than 5.3

Fixed

Fixed issue accessing returned array directly on PHP less than 5.3 (CUBE-API-1X)

Fixed

Fixed incorrect timed reminder ID name (CUBE-API-2A, CUBE-API-2B)

Fixed

Fixed missing result object in NFC API Route (CUBE-API-2E)

Fixed

Fixed error with missing 'hw_type' during login (CUBE-API-2D)

Fixed

Fixed error returning newly created auth log entries (CUBE-API-2C)

2.8.4
May 21, 2019
Added

Added /api/timedreminder endpoint for handling timed reminders

Added

Added /api/patientdata endpoint for handling arbitrary patient data

Fixed

Added detection of same device login in /api/auth/rcmuser

Fixed

Redirected rcm-client updates over version 3.x to rcm-client-android

Fixed

Fixed installer to add rcm_devices table for RCube installs

2.8.3
March 18, 2019
Added

Added automatic RCM Device update and creation on /api/auth/rcmuser

Added

Added new fields to /api/rcmdevice to support better device identification

Added

Added /api/update/[id]/apply endpoint for applying updates to devices

Added

Added /api/update/[id]/rcmdevices endpoint for finding devices with applied update

Added

Added /api/rcmdevice/[id]/updates endpoint for finding updates applied to device

Added

Added logic for multi-purpose LED 2 in /api/status/led

Fixed

Resized deviceid column in authlog to handle bcube-ui UUIDs

2.8.2
January 30, 2019
Added

Added /api/rcmdevice endpoint for handling RCare Mobile devices

Added

Added green_dome value to accounts to allow for setting of presence dome light

Added

Added allactive to GET /api/incident endpoint that always returns active incidents first

Fixed

Added DB version checking for API calls for recently added fields

2.8.1
December 18, 2018
Fixed

Fixed account photo path on RCubes

Fixed

Fixed token refresh for apps (closes #8)

2.8.0
November 28, 2018
Added

Added /api/update endpoint for handling update objects

Added

Added /api/update/check endpoint for checking for available updates

Added

Added /api/update/download endpoint for downloading binary updates

Added

Removed unused /api/broadcast endpoint

Added

Added documentation for remote API access

Added

Updated all composer libraries

2.7.6
October 24, 2018
Added

Added field_lock field to Account API

Fixed

Improved logging output to be less spammy and more informative

2.7.5
October 2, 2018
Added

Added detection of DISABLE_ADLS def to disable ADLs for new RCare Mobile apps

Fixed

Changed Debian package installer to use safer method of installation

2.7.4
September 17, 2018
Fixed

Added check for failing connected RCM user call (fixes #7)

Fixed

Fixed issue with very short usernames incorrectly showing up as logged in

2.7.3
July 20, 2018
Fixed

Handled missing RCM license counts

Fixed

Handled iOS license check better, only do if iOS license is requested

2.7.2
July 13, 2018
Fixed

Added check to only do text-to-speech for non-Rcubes

2.7.1
July 12, 2018
Fixed

Handled non-Vcube params on account updates to Rcubes

2.7.0
July 12, 2018
Added

Limited number of allowed iOS logins to new rcm_ios_licenses field

Added

Generated text-to-speech audio for created/updated accounts by using tts=true field

2.6.3
July 6, 2018
Added

Added rcare-alexa app auth

Fixed

Rename packages for Debian stretch during install/update

Fixed

Added check for blank account in AlarmManager (closes #5)

Fixed

Added catch for invalid view ID in incident filter (closes #6)

Fixed

Rearranged app auths to make them more consistent

2.6.2
July 2, 2018
Added

Added DELETE /api/device/echo/[id] endpoint to delete Amazon Echo devices

2.6.1
June 20, 2018
Added

Added /api/token/wakeup endpoint to allow for notification of external tokens

Added

Added curl extentions to php for Alexa Echo integration support

Fixed

Use option based identifier for RCM users for legacy cubes

Fixed

Round durations from database for call_metrics, since milli/micros show up as decimals

Fixed

Use default shift times when calculating shift metrics

Fixed

Allow debian package list to be updated

2.6.0
May 25, 2018
Added

Added /api/metrics/call endpoint to return call metrics

Added

Added /api/token/apn endpoint to allow for Apple Push Notification integration

Added

Added filter options to /api/user endpoint, including rcmactive to ruturn only currently logged in RCM users

Fixed

Added missing type field to /api/user endpoint operations

Fixed

Removed default/test app authentication secrets

Fixed

Incident Log items returns in newest-to-oldest order instead of unordered

2.5.3
May 23, 2018
Fixed

Allow RCM users to login to an RCube if CC900 preference is set

2.5.2
May 2, 2018
Fixed

IncidentManager no longer recognizes view 1 as a default view

Fixed

Add hash to the end of all user and account images to bypass caching

2.5.1
April 10, 2018
Fixed

Added missing server notifications on database changes

Fixed

Added missing server notifications on user picture change

Fixed

Fixing LocatorManager unit tests

2.5.0
March 19, 2018
Added

Allow GET /api/view to ge called unauthenticated. Resolves some bootstrapping issues for external applications

Added

Added /api/authlog endpoint to handle authentication logging

Added

Added /api/locator endpoint to handle locator management

Added

Automatically generate auth_log entry on successful /api/auth/user and /api/auth/rcmuser calls

Added

Added ALP to /api/settings for identifying ALP (advanced locating protocol) sites

Added

Added has_fault and associated fault flags to objects returned from /api/device

Added

Added filtering on /api/device, including has_fault

2.4.3
March 5, 2018
Added

Added checks to prevent default view from being updated

Added

Added release and user context to sentry.io reporting

Fixed

Corrected default view to be 0, not 1

2.4.2
March 1, 2018
Fixed

Fixed issue with identifying PNG images in PhotoManager

Fixed

Fixed missing account photos under certain circumstances

2.4.1
February 21, 2018
Added

POST and PUT requests accept JSON encoded paramaters with content ype of 'application/json'

Fixed

Fixed filtering of incidents for default view (Issue #1)

Fixed

Ignore any view provided to the incident filter that is less than 1

Fixed

Return error if incident filter provided with non-existent view ID (Issue #2)

Fixed

Removed ability to delete default view and default view members

Fixed

rcm-server user (rcare2) is not counted against the number of used licenses (Issue #4)

2.4.0
January 30, 2018
Added

Added limit and offset support to /api/adllog

Added

Added /api/account/photo API to support account photos

Added

Added /api/user/photo API to support user photos

Added

Added /api/nfc API to support NFC tags

Added

Added photoPath as member of Account and User objects for quick photo access

Fixed

Fixed /api/view/member API signature to more industry standard format

Fixed

Moved more server defined constants into configuration

Fixed

Cleaned up functions causing entries in error log

2.3.0
November 29, 2017
Added

Added /api/broadcast/ endpoint to handle broadcasts

Added

Added /api/auth/rcmuser endpoint to handle logins for RCare Mobile, which checks available licenses, user type, and current login status

Added

Auth API now returns ttl that specifies how long an access token has to live

Added

Access tokens for users now have a TTL that is equal to the login_duration defined for the user

Added

Added limit filter to /api/incident

Added

Defaulted to order by start_time descending for /api/incident

Fixed

Required Account find by room 'address1' and 'address2' parameters

Fixed

Fixed docs for Account find by room

2.2.1
November 10, 2017
Fixed

Fixed installer suppressing apt-get output, possibly causing hangs

2.2.0
January 1, 1970
Added

Implemented PUT support for updating. POST with ID will still work, but is considered deprecated

Added

Added /api/versions/ endpoint for pulling all versioning info from a Cube

Added

Added /api/status/led/ endpoint for pulling status of Cube front panel LEDs

Added

Added site to /api/ endpoint to easily identify Cube site

Added

Moved DB_ver from /api/ to /ap/versions/ endpoint

2.1.1
October 4, 2017
Added

Converted to a gradle build for packaging and deployment

Added

Added back self-contained install script

Fixed

Use package list to selectivly install debian packages to prevent issues on legacy cubes

Fixed

Prevent API failure if DB_Ver is missing from database (very, very old cubes)

2.1.0
January 1, 1970
Added

Added view and view/member endpoints to handle incident views

Added

Added incident filtering, including filtering by view. See GET /api/incident/ in the API Spec for details

Added

Removed DELETE action from incident endpoint

2.0.1
January 1, 1970
Added

Disabled access to adl and adllog API endpoints for sites that do not have RCare Mobile enabled. Returns 400 Bad Request status in that case

Added

Added device related Alarm fields independent of the device parameter lookup. This allows API clients to add alarms for devices that are not defined in the devices table

2.0.0
January 1, 1970
Added

Refactored to run under pers directory on RCube

Added

Changed logging location to be syslog.LOCAL3 instead of unique file following pers protocol

Added

Changed database user to be same as used in pers