Difference between revisions of "Internal GCAPI"

From GrandCare Systems
Jump to navigation Jump to search
Line 1: Line 1:
== Introduction ==
To access the Como API you first need the passcodes to they system via [[GCManage API]].
To access the Como API you first need the passcodes to they system via [[GCManage API]].


== Como API ==
If you're on the same network as the GrandCare system, you can call directly to it's IP address.  If not, you'll need to get the public URL from the [[GCManage API]] [[GCManage API#remotelogin|remotelogin]] service.
If you're on the same network as the GrandCare system, you can call directly to it's IP address.  If not, you'll need to get the public URL from the GCManage API remotelogin service.


This URL (whether private IP or public address) will be referenced as '''$SystemAddress''' in the rest of the documentation.
This URL (whether private IP or public address) will be referenced as '''$SystemAddress''' in the rest of the documentation.

Revision as of 17:50, 1 August 2012

Introduction

To access the Como API you first need the passcodes to they system via GCManage API.

If you're on the same network as the GrandCare system, you can call directly to it's IP address. If not, you'll need to get the public URL from the GCManage API remotelogin service.

This URL (whether private IP or public address) will be referenced as $SystemAddress in the rest of the documentation.

$SystemAddress Examples

http://gcmanage.grandcare.com:21000/
http://192.168.0.5/
http://10.100.1.5/

History

  • URL: $SystemAddress/api/history.php
  • Global Parameters
    • op: API Operation (see list below)
    • encoding ("json" or "xml")
    • passcode: System passcode from GCManage API

bp (Blood Pressure)

Results

$ curl "http://10.100.1.2/api/history.php?op=bp&encoding=json&passcode=YkdrYUpUOEVVRDhMZFQ4SlB6OC9kdz09"
{
   "gcapi": {
       "result": "SUCCESS",
       "bp": [
           {
               "timestamp": "07/31/12 08:15:57",
               "deviceId": "1001",
               "residentId": "cf6ff892-3124-41ef-8c77-e729f0f66fc5",
               "systolic": "134",
               "diastolic": "95",
               "pulse": "54",
               "mean-ap": "117"
           },
           {
               "timestamp": "07/28/12 07:51:16",
               "deviceId": "1001",
               "residentId": "cf6ff892-3124-41ef-8c77-e729f0f66fc5",
               "systolic": "134",
               "diastolic": "89",
               "pulse": "51",
               "mean-ap": "104"
           }
       ],
       "totalEntries": "2"
   }
}

weight

Results

$ curl "http://10.100.1.2/api/history.php?op=weight&encoding=json&passcode=YkdrYUpUOEVVRDhMZFQ4SlB6OC9kdz09"
{
   "gcapi": {
       "result": "SUCCESS",
       "weight": [
           {
               "timestamp": "07/31/12 08:14:45",
               "deviceId": "1000",
               "residentId": "cf6ff892-3124-41ef-8c77-e729f0f66fc5",
               "value": "176.6"
           },
           {
               "timestamp": "07/28/12 07:49:32",
               "deviceId": "1000",
               "residentId": "cf6ff892-3124-41ef-8c77-e729f0f66fc5",
               "value": "176.2"
           }
       ],
       "totalEntries": "2"
   }
}

temp (Indoor Temperature)

Results

$ curl "http://10.100.1.2/api/history.php?op=temp&encoding=json&passcode=YkdrYUpUOEVVRDhMZFQ4SlB6OC9kdz09"
{
   "gcapi": {
       "result": "SUCCESS",
       "temp": [
           {
               "timestamp": "07/20/12 12:06:18",
               "deviceId": "103",
               "value": "73"
           },
           {
               "timestamp": "07/20/12 11:53:14",
               "deviceId": "103",
               "value": "74"
           }
       ],
       "totalEntries": "2"
   }
}