Internal GCAPI - Revision history

Eumhoefer at 22:00, 19 July 2017

2017-07-19T22:00:15Z

Eumhoefer at 21:18, 14 July 2017

2017-07-14T21:18:55Z

← Older revision		Revision as of 21:18, 14 July 2017
Line 75:		Line 75:

	== Assign API ==		== Assign API ==
	The [[Assign API Subsystem\|Assign subsystem]] allows you to assign and delete wellness readings from a system.		The [[Internal Assign API Subsystem\|Assign subsystem]] allows you to assign and delete wellness readings from a system.

	See [[Assign API Subsystem\|documentation]] for details or click an specific Assign operation below		See [[Internal Assign API Subsystem\|documentation]] for details or click an specific Assign operation below
	=== [[Assign API Subsystem#assign\|Assign Reading]] ===		=== [[Internal Assign API Subsystem#assign\|Assign Reading]] ===
	Assigns a wellness reading to a resident		Assigns a wellness reading to a resident
	=== [[Assign API Subsystem#delete\|Delete Reading]] ===		=== [[Internal Assign API Subsystem#delete\|Delete Reading]] ===
	Marks a wellness reading as deleted		Marks a wellness reading as deleted

Eumhoefer: Removed accidental extra bracket

2017-07-10T18:25:21Z

Removed accidental extra bracket

Eumhoefer: Added Internal to Medication API Subsystem

2017-07-10T18:23:39Z

Added Internal to Medication API Subsystem

Eumhoefer: Added Internal to GCManage API

2017-07-10T16:48:21Z

Added Internal to GCManage API

← Older revision		Revision as of 16:48, 10 July 2017
Line 5:		Line 5:
	http://[como-URL]/api/[api-subsystem].php?passcode=[my-passcode]&op=[operation]&encoding=[json\|xml]		http://[como-URL]/api/[api-subsystem].php?passcode=[my-passcode]&op=[operation]&encoding=[json\|xml]

	The como URL and passcode are from the results of a [[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.		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 =		= Local Application Authentication =

Eumhoefer: Eumhoefer moved page GCAPI to Internal GCAPI: Internal Page

2017-07-10T16:46:54Z

Eumhoefer moved page GCAPI to Internal GCAPI: Internal Page

← Older revision	Revision as of 16:46, 10 July 2017
(No difference)

Eumhoefer: Fixed Spelling Error

2017-07-10T16:22:57Z

Fixed Spelling Error

← Older revision		Revision as of 16:22, 10 July 2017
Line 84:		Line 84:

	== Caregiver API ==		== Caregiver API ==
	The [[~~Interna~~ Caregiver API Subsystem\|Caregiver subsystem]] allows you to create, read, update, and delete caregivers from a system.		The [[Internal Caregiver API Subsystem\|Caregiver subsystem]] allows you to create, read, update, and delete caregivers from a system.

	See [[Internal Caregiver API Subsystem\|documentation]] for details or click an specific Caregiver operation below		See [[Internal Caregiver API Subsystem\|documentation]] for details or click an specific Caregiver operation below

Eumhoefer: Added Internal to Caregiver API Subsystem

2017-07-10T16:21:02Z

Added Internal to Caregiver API Subsystem

← Older revision		Revision as of 16:21, 10 July 2017
Line 84:		Line 84:

	== Caregiver API ==		== Caregiver API ==
	The [[Caregiver API Subsystem\|Caregiver subsystem]] allows you to create, read, update, and delete caregivers from a system.		The [[Interna Caregiver API Subsystem\|Caregiver subsystem]] allows you to create, read, update, and delete caregivers from a system.

	See [[Caregiver API Subsystem\|documentation]] for details or click an specific Caregiver operation below		See [[Internal Caregiver API Subsystem\|documentation]] for details or click an specific Caregiver operation below
	=== [[Caregiver API Subsystem#create\|Create]] ===		=== [[Internal Caregiver API Subsystem#create\|Create]] ===
	Create a caregiver		Create a caregiver
	=== [[Caregiver API Subsystem#read\|Read]] ===		=== [[Internal Caregiver API Subsystem#read\|Read]] ===
	Reads a single caregiver or all caregivers		Reads a single caregiver or all caregivers
	=== [[Caregiver API Subsystem#update\|Update]] ===		=== [[Internal Caregiver API Subsystem#update\|Update]] ===
	Updates an existing caregiver		Updates an existing caregiver
	=== [[Caregiver API Subsystem#delete\|Delete]] ===		=== [[Internal Caregiver API Subsystem#delete\|Delete]] ===
	Deletes an existing caregiver		Deletes an existing caregiver

Eumhoefer: Fixed ActivityLog API Subsystem to link to Internal ActivityLog API Subsystem

2017-07-10T15:47:48Z

Fixed ActivityLog API Subsystem to link to Internal ActivityLog API Subsystem

← Older revision		Revision as of 15:47, 10 July 2017
Line 129:		Line 129:

	== ActivityLog API ==		== ActivityLog API ==
	The [[ActivityLog API Subsystem\|Activity Log subsystem]] allows you to view a log of touchscreen events		The [[Internal ActivityLog API Subsystem\|Activity Log subsystem]] allows you to view a log of touchscreen events
	=== [[ActivityLog API Subsystem#read\|Read]] ===		=== [[Internal ActivityLog API Subsystem#read\|Read]] ===
	Read entries out of the log		Read entries out of the log
	=== [[ActivityLog API Subsystem#add\|Add]] ===		=== [[Internal ActivityLog API Subsystem#add\|Add]] ===
	Add entries to the log		Add entries to the log

Ngh: /* TODO */

2013-12-13T19:56:17Z

TODO

← Older revision		Revision as of 19:56, 13 December 2013
Line 153:		Line 153:
	* notification api		* notification api
	* calendar api		* calendar api
			* letters api

	= Other Resources =		= Other Resources =
	* [https://github.com/ngharo/gc-javascript-api Experimental JavaScript library]		* [https://github.com/ngharo/gc-javascript-api Experimental JavaScript library]

← Older revision		Revision as of 22:00, 19 July 2017
Line 52:		Line 52:
	= API Subsystems =		= API Subsystems =
	== History API ==		== History API ==
	The [[~~History~~ API Subsystem\|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.		The [[InternalHistory API Subsystem\|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 [[History API Subsystem\|documentation]] for details or click an specific History operation below		See [[Internal History API Subsystem\|documentation]] for details or click an specific History operation below
	=== [[History API Subsystem#bp\|Blood Pressure]] ===		=== [[Internal History API Subsystem#bp\|Blood Pressure]] ===
	Fetches blood pressure sensor history from the system		Fetches blood pressure sensor history from the system
	=== [[History API Subsystem#weight\|Weight Scale]] ===		=== [[Internal History API Subsystem#weight\|Weight Scale]] ===
	Fetches scale history from the system		Fetches scale history from the system
	=== [[History API Subsystem#temp\|Temperature Sensor]] ===		=== [[Internal History API Subsystem#temp\|Temperature Sensor]] ===
	Fetches temperature sensor history from the system		Fetches temperature sensor history from the system
	=== [[History API Subsystem#bed\|Bed Sensor]] ===		=== [[Internal History API Subsystem#bed\|Bed Sensor]] ===
	Fetches bed sensor history from the system		Fetches bed sensor history from the system
	=== [[History API Subsystem#oxi\|Oximeter]] ===		=== [[Internal History API Subsystem#oxi\|Oximeter]] ===
	Fetches oximeter history from the system		Fetches oximeter history from the system
	=== [[History API Subsystem#motion\|Motion]] ===		=== [[Internal History API Subsystem#motion\|Motion]] ===
	Fetches motion sensor history from the system		Fetches motion sensor history from the system
	=== [[History API Subsystem#gluc\|Glucometer]] ===		=== [[Internal History API Subsystem#gluc\|Glucometer]] ===
	Fetches glucometer history from the system		Fetches glucometer history from the system
	=== [[History API Subsystem#door\|Door Sensor]] ===		=== [[Internal History API Subsystem#door\|Door Sensor]] ===
	Fetches door sensor history from the system		Fetches door sensor history from the system
	=== [[History API Subsystem#cid\|Caller ID]] ===		=== [[Internal History API Subsystem#cid\|Caller ID]] ===
	Fetches caller ID history from the system		Fetches caller ID history from the system

← Older revision		Revision as of 18:25, 10 July 2017
Line 99:		Line 99:
	The [[Internal Medication API Subsystem\|Medication subsystem]] allows you to manage medication and schedules from a system.		The [[Internal Medication API Subsystem\|Medication subsystem]] allows you to manage medication and schedules from a system.

	See [[[Internal Medication API Subsystem\|documentation]] for details or click an specific Medication operation below		See [[Internal Medication API Subsystem\|documentation]] for details or click an specific Medication operation below
	=== [[[Internal Medication API Subsystem#createPrescription\|Create Prescription]] ===		=== [[Internal Medication API Subsystem#createPrescription\|Create Prescription]] ===
	Create a prescription		Create a prescription
	=== [[[Internal Medication API Subsystem#readPrescription\|Read Prescription]] ===		=== [[Internal Medication API Subsystem#readPrescription\|Read Prescription]] ===
	Reads a single prescription or all prescriptions		Reads a single prescription or all prescriptions
	=== [[[Internal Medication API Subsystem#updatePrescription\|Update]] ===		=== [[Internal Medication API Subsystem#updatePrescription\|Update]] ===
	Updates an existing prescription		Updates an existing prescription
	=== [[[Internal Medication API Subsystem#deletePrescription\|Delete]] ===		=== [[Internal Medication API Subsystem#deletePrescription\|Delete]] ===
	Deletes an existing prescription		Deletes an existing prescription
	=== [[[Internal Medication API Subsystem#storePrescriptionPic\|Store Picture]] ===		=== [[Internal Medication API Subsystem#storePrescriptionPic\|Store Picture]] ===
	Stores a picture for a prescription		Stores a picture for a prescription

	=== [[[Internal Medication API Subsystem#createSchedule\|Create Prescription Schedule]] ===		=== [[Internal Medication API Subsystem#createSchedule\|Create Prescription Schedule]] ===
	Create a prescription schedule		Create a prescription schedule
	=== [[[Internal Medication API Subsystem#readSchedule\|Read Prescription Schedule]] ===		=== [[Internal Medication API Subsystem#readSchedule\|Read Prescription Schedule]] ===
	Reads a single prescription schedule or all prescription schedules		Reads a single prescription schedule or all prescription schedules
	=== [[[Internal Medication API Subsystem#updateSchedule\|Update Prescription Schedule]] ===		=== [[Internal Medication API Subsystem#updateSchedule\|Update Prescription Schedule]] ===
	Updates an existing prescription schedule		Updates an existing prescription schedule
	=== [[[Internal Medication API Subsystem#deleteSchedule\|Delete Prescription Schedule]] ===		=== [[Internal Medication API Subsystem#deleteSchedule\|Delete Prescription Schedule]] ===
	Deletes an existing prescription schedule		Deletes an existing prescription schedule
	=== [[[Internal Medication API Subsystem#setCompliance\|Set Compliance]] ===		=== [[Internal Medication API Subsystem#setCompliance\|Set Compliance]] ===
	Set compliance on an existing prescription schedule		Set compliance on an existing prescription schedule
	=== [[[Internal Medication API Subsystem#checkCompliance\|Check Compliance]] ===		=== [[Internal Medication API Subsystem#checkCompliance\|Check Compliance]] ===
	Check compliance on an existing prescription schedule		Check compliance on an existing prescription schedule
	=== [[[Internal Medication API Subsystem#backfillCompliance\|Backfill Compliance]] ===		=== [[Internal Medication API Subsystem#backfillCompliance\|Backfill Compliance]] ===
	Backfill compliance on an existing prescription schedule		Backfill compliance on an existing prescription schedule
	=== [[[Internal Medication API Subsystem#RxLookup\|Lookup Rx]] ===		=== [[Internal Medication API Subsystem#RxLookup\|Lookup Rx]] ===
	Finds Rx via FDA NDC Directory		Finds Rx via FDA NDC Directory

← Older revision		Revision as of 18:23, 10 July 2017
Line 97:		Line 97:

	== Medication API ==		== Medication API ==
	The [[Medication API Subsystem\|Medication subsystem]] allows you to manage medication and schedules from a system.		The [[Internal Medication API Subsystem\|Medication subsystem]] allows you to manage medication and schedules from a system.

	See [[Medication API Subsystem\|documentation]] for details or click an specific Medication operation below		See [[[Internal Medication API Subsystem\|documentation]] for details or click an specific Medication operation below
	=== [[Medication API Subsystem#createPrescription\|Create Prescription]] ===		=== [[[Internal Medication API Subsystem#createPrescription\|Create Prescription]] ===
	Create a prescription		Create a prescription
	=== [[Medication API Subsystem#readPrescription\|Read Prescription]] ===		=== [[[Internal Medication API Subsystem#readPrescription\|Read Prescription]] ===
	Reads a single prescription or all prescriptions		Reads a single prescription or all prescriptions
	=== [[Medication API Subsystem#updatePrescription\|Update]] ===		=== [[[Internal Medication API Subsystem#updatePrescription\|Update]] ===
	Updates an existing prescription		Updates an existing prescription
	=== [[Medication API Subsystem#deletePrescription\|Delete]] ===		=== [[[Internal Medication API Subsystem#deletePrescription\|Delete]] ===
	Deletes an existing prescription		Deletes an existing prescription
	=== [[Medication API Subsystem#storePrescriptionPic\|Store Picture]] ===		=== [[[Internal Medication API Subsystem#storePrescriptionPic\|Store Picture]] ===
	Stores a picture for a prescription		Stores a picture for a prescription

	=== [[Medication API Subsystem#createSchedule\|Create Prescription Schedule]] ===		=== [[[Internal Medication API Subsystem#createSchedule\|Create Prescription Schedule]] ===
	Create a prescription schedule		Create a prescription schedule
	=== [[Medication API Subsystem#readSchedule\|Read Prescription Schedule]] ===		=== [[[Internal Medication API Subsystem#readSchedule\|Read Prescription Schedule]] ===
	Reads a single prescription schedule or all prescription schedules		Reads a single prescription schedule or all prescription schedules
	=== [[Medication API Subsystem#updateSchedule\|Update Prescription Schedule]] ===		=== [[[Internal Medication API Subsystem#updateSchedule\|Update Prescription Schedule]] ===
	Updates an existing prescription schedule		Updates an existing prescription schedule
	=== [[Medication API Subsystem#deleteSchedule\|Delete Prescription Schedule]] ===		=== [[[Internal Medication API Subsystem#deleteSchedule\|Delete Prescription Schedule]] ===
	Deletes an existing prescription schedule		Deletes an existing prescription schedule
	=== [[Medication API Subsystem#setCompliance\|Set Compliance]] ===		=== [[[Internal Medication API Subsystem#setCompliance\|Set Compliance]] ===
	Set compliance on an existing prescription schedule		Set compliance on an existing prescription schedule
	=== [[Medication API Subsystem#checkCompliance\|Check Compliance]] ===		=== [[[Internal Medication API Subsystem#checkCompliance\|Check Compliance]] ===
	Check compliance on an existing prescription schedule		Check compliance on an existing prescription schedule
	=== [[Medication API Subsystem#backfillCompliance\|Backfill Compliance]] ===		=== [[[Internal Medication API Subsystem#backfillCompliance\|Backfill Compliance]] ===
	Backfill compliance on an existing prescription schedule		Backfill compliance on an existing prescription schedule
	=== [[Medication API Subsystem#RxLookup\|Lookup Rx]] ===		=== [[[Internal Medication API Subsystem#RxLookup\|Lookup Rx]] ===
	Finds Rx via FDA NDC Directory		Finds Rx via FDA NDC Directory