Internal GCAPI

From GrandCare Systems
Jump to navigation Jump to search

GCAPI gives developers access to the core tools provided by a GCManage server and como systems. A variety of tasks can be performed by making simple web service calls.

Calling GCAPI

A basic call to GCAPI looks like this:


The como URL and passcode are from the results of a Internal GCManage API remote login call. The como URL is what GCManage determines is the path to the como system. This can either be proxied or the direct IP of the system. passcode is the authentication mechanism used by GCAPI -- it is a code generated every 24 hours by a system and reported to GCManage. subsystem names the subsystem you want to work on and operation defines the actual operation to perform. Each operation can have a number of other parameters that will be passed via other parameters in the URL.

Local Application Authentication

Applications may also want to call the API without an associated GCManage account. GrandCare will provide each application an "application key" that allows for a simple way to fetch the required passcodes. To do this, call the API via "localhost" using the following URL:


This will return the required passcodes for making authenticated calls to the API. See the section on the System API Subsystem for more information about the getpasscodes API call.

Results From GCAPI

The response from GCAPI will either be encoded in JSON or XML, depending on the requested encoding. By default the response will be encoded in XML.

XML Results

By default, GCAPI responds to commands by returning an XML document. Here is the most basic success result:


The root XML element for all GCAPI results is gcapi. The other always present element is result, which contains either SUCCESS or FAILURE, depending on whether the call succeeded or not. A failure response also contains the fail-message element, which gives the reasons for the failure. For example:

   <fail-message>Invalid credentials for API call</fail-message>

This result would occur if invalid credentials were supplied during the GCAPI call.

JSON Results

GCAPI can also respond by returning a JSON object. Here is the most basic success result:

   "gcapi": {
       "result": "SUCCESS"

A failure encoded in JSON looks like:

   "gcapi": {
       "result": "FAILURE",
       "fail-message": "Invalid credentials for API call"

API Subsystems

History API

The History subsystem allows you to fetch ADL and wellness data from a system. Most of the operations take the same parameters and return different data.

See documentation for details or click an specific History operation below

Blood Pressure

Fetches blood pressure sensor history from the system

Weight Scale

Fetches scale history from the system

Temperature Sensor

Fetches temperature sensor history from the system

Bed Sensor

Fetches bed sensor history from the system


Fetches oximeter history from the system


Fetches motion sensor history from the system


Fetches glucometer history from the system

Door Sensor

Fetches door sensor history from the system

Caller ID

Fetches caller ID history from the system

Assign API

The Assign subsystem allows you to assign and delete wellness readings from a system.

See documentation for details or click an specific Assign operation below

Assign Reading

Assigns a wellness reading to a resident

Delete Reading

Marks a wellness reading as deleted

Caregiver API

The Caregiver subsystem allows you to create, read, update, and delete caregivers from a system.

See documentation for details or click an specific Caregiver operation below


Create a caregiver


Reads a single caregiver or all caregivers


Updates an existing caregiver


Deletes an existing caregiver

Medication API

The Medication subsystem allows you to manage medication and schedules from a system.

See documentation for details or click an specific Medication operation below

Create Prescription

Create a prescription

Read Prescription

Reads a single prescription or all prescriptions


Updates an existing prescription


Deletes an existing prescription

Store Picture

Stores a picture for a prescription

Create Prescription Schedule

Create a prescription schedule

Read Prescription Schedule

Reads a single prescription schedule or all prescription schedules

Update Prescription Schedule

Updates an existing prescription schedule

Delete Prescription Schedule

Deletes an existing prescription schedule

Set Compliance

Set compliance on an existing prescription schedule

Check Compliance

Check compliance on an existing prescription schedule

Backfill Compliance

Backfill compliance on an existing prescription schedule

Lookup Rx

Finds Rx via FDA NDC Directory

ActivityLog API

The Activity Log subsystem allows you to view a log of touchscreen events


Read entries out of the log


Add entries to the log


  • assign api
  • caregiver api
  • carenote api
  • configure api
  • device api
  • history api
  • log api
  • media api
  • medication api
  • message api
  • pin api
  • resident api
  • rule api
  • system api
  • activitylog api
  • notification api
  • calendar api
  • letters api

Other Resources