Internal Caregiver API Subsystem - Revision history

Eumhoefer: Added Internal to GCAPI

2017-07-10T16:43:51Z

Added Internal to GCAPI

← Older revision		Revision as of 16:43, 10 July 2017
Line 1:		Line 1:
	The Caregiver subsystem allows you to create, view, edit and delete caregivers from a system via [[GCAPI]].		The Caregiver subsystem allows you to create, view, edit and delete caregivers from a system via [[Internal GCAPI]].
	= Operations =		= Operations =
	== create ==		== create ==

Eumhoefer: Eumhoefer moved page Caregiver API Subsystem to Internal Caregiver API Subsystem: Internal Page

2017-07-10T16:21:26Z

Eumhoefer moved page Caregiver API Subsystem to Internal Caregiver API Subsystem: Internal Page

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

Ngh: /* Parameters */

2012-10-11T21:23:55Z

Parameters

← Older revision		Revision as of 21:23, 11 October 2012
Line 124:		Line 124:
	* ''firstname'' - [optional] - First name		* ''firstname'' - [optional] - First name
	* ''lastname'' - [optional] - Last name		* ''lastname'' - [optional] - Last name
			* ''nickname'' - [optional] - Nick name
	* ''email'' - [optional] - Email address		* ''email'' - [optional] - Email address
	* ''address'' - [optional] - Street address		* ''address'' - [optional] - Street address
			* ''address2'' - [optional] - Street address2
	* ''city'' - [optional] - City		* ''city'' - [optional] - City
	* ''state'' - [optional] - State		* ''state'' - [optional] - State
	* ''zip'' - [optional] - Zip code		* ''zip'' - [optional] - Zip code
			* ''country'' - [optional] - ISO3166 Country code
	* ''homephone'' - [optional] - Home phone number		* ''homephone'' - [optional] - Home phone number
	* ''workphone'' - [optional] - Work phone number		* ''workphone'' - [optional] - Work phone number

Ngh: /* json */

2012-10-11T21:22:09Z

json

← Older revision		Revision as of 21:22, 11 October 2012
Line 54:		Line 54:
	"firstname": "Nicholas",		"firstname": "Nicholas",
	"lastname": "Hall",		"lastname": "Hall",
			"nickname": " ",
	"address": "123 Fake St",		"address": "123 Fake St",
			"address2": " ",
	"city": "West Bend",		"city": "West Bend",
	"state": "WI",		"state": "WI",
	"zipcode": "53095",		"zipcode": "53095",
			"country": " ",
	"homephone": " ",		"homephone": " ",
	"workphone": " ",		"workphone": " ",

Ngh: /* xml */

2012-10-11T21:21:37Z

xml

← Older revision		Revision as of 21:21, 11 October 2012
Line 34:		Line 34:
	<address2> </address2>		<address2> </address2>
	<city>West Bend</city>		<city>West Bend</city>
	<country> </country>		<country> </country>
	<state>WI</state>		<state>WI</state>
	<zipcode>53095</zipcode>		<zipcode>53095</zipcode>

Ngh: /* xml */

2012-10-11T21:21:28Z

xml

← Older revision		Revision as of 21:21, 11 October 2012
Line 30:		Line 30:
	<firstname>Nicholas</firstname>		<firstname>Nicholas</firstname>
	<lastname>Hall</lastname>		<lastname>Hall</lastname>
			<nickname> </nickname>
	<address>123 Fake St</address>		<address>123 Fake St</address>
			<address2> </address2>
	<city>West Bend</city>		<city>West Bend</city>
			<country> </country>
	<state>WI</state>		<state>WI</state>
	<zipcode>53095</zipcode>		<zipcode>53095</zipcode>

Ngh: /* Parameters */

2012-10-11T21:20:36Z

Parameters

Ngh: /* update */

2012-08-02T20:50:44Z

update

← Older revision		Revision as of 20:50, 2 August 2012
Line 110:		Line 110:

	== update ==		== update ==
	Updates a caregiver		Updates an existing caregiver
	=== Parameters ===		=== Parameters ===
	* ''id'' - [required] - ID of caregiver to update		* ''id'' - [required] - ID of caregiver to update

Ngh: Created page with "The Caregiver subsystem allows you to create, view, edit and delete caregivers from a system via GCAPI. = Operations = == create == Create a caregiver === Parameters === *..."

2012-08-02T20:47:36Z

Created page with "The Caregiver subsystem allows you to create, view, edit and delete caregivers from a system via GCAPI. = Operations = == create == Create a caregiver === Parameters === *..."

New page

The Caregiver subsystem allows you to create, view, edit and delete caregivers from a system via [[GCAPI]].
= Operations =
== create ==
Create a caregiver
=== Parameters ===
* ''firstname'' - [required] - First name
* ''lastname'' - [required] - Last name
* ''id'' - [optional] - Unique ID in UUID format
* ''email'' - [optional] - Email address
* ''address'' - [optional] - Street address
* ''city'' - [optional] - City
* ''state'' - [optional] - State
* ''zip'' - [optional] - Zip code
* ''homephone'' - [optional] - Home phone number
* ''workphone'' - [optional] - Work phone number
* ''cellphone'' - [optional] - Cell phone number
* ''pager'' - [optional] - Pager phone number

=== Results ===
SUCCESS, returns back saved caregiver
==== xml ====
$ curl "http://10.100.1.2/api/caregiver.php?op=create&encoding=xml&passcode=x&firstname=Nicholas&lastname=Hall&address=123+Fake+St&state=WI&zipcode=53095&city=West+Bend"
<gcapi>
<result>SUCCESS</result>
<caregiver>
<id>cbaaf355-9c16-4a24-858b-869f6bf303f9</id>
<firstname>Nicholas</firstname>
<lastname>Hall</lastname>
<address>123 Fake St</address>
<city>West Bend</city>
<state>WI</state>
<zipcode>53095</zipcode>
<homephone> </homephone>
<workphone> </workphone>
<cellphone> </cellphone>
<pager> </pager>
<email> </email>
</caregiver>
</gcapi>

==== json ====
$ curl "http://10.100.1.2/api/caregiver.php?op=create&encoding=json&passcode=x&firstname=Nicholas&lastname=Hall&address=123+Fake+St&state=WI&zipcode=53095&city=West+Bend"
{
"gcapi": {
"result": "SUCCESS",
"caregiver": {
"id": "93c2dc15-20b3-4884-81ca-6f57335a1bdb",
"firstname": "Nicholas",
"lastname": "Hall",
"address": "123 Fake St",
"city": "West Bend",
"state": "WI",
"zipcode": "53095",
"homephone": " ",
"workphone": " ",
"cellphone": " ",
"pager": " ",
"email": " "
}
}
}

== read ==
Reads a single caregiver or all caregivers
=== Parameters ===
* ''id'' - [optional] - ID of specific caregiver to read. If left blank, reads all caregivers
=== Results ===
Returns SUCCESS and a single caregiver or all caregivers in the following format:
==== xml ====
<gcapi>
<result>SUCCESS</result>
<caregiver>
<id>5f3e081d-e6af-4dd6-a6b8-dd4d8890e611</id>
<firstname>Shirley</firstname>
<lastname>Doe</lastname>
<address>2412 West Washington Ave</address>
<city>West Bend</city>
<state>WI</state>
<zipcode>53095</zipcode>
<homephone>2623349394</homephone>
<workphone>2623386147</workphone>
<cellphone>2626896732</cellphone>
<pager></pager>
<email>shirley@grandcare.com</email>
</caregiver>
</gcapi>

==== json ====
{
"gcapi": {
"result": "SUCCESS",
"caregiver": [
{
"id": "5f3e081d-e6af-4dd6-a6b8-dd4d8890e611",
"firstname": "Shirley",
"lastname": "Doe",
"address": "2412 West Washington Ave",
"city": "West Bend",
"state": "WI",
"zipcode": "53095",
"homephone": "2623349394",
"workphone": "2623386147",
"cellphone": "2626896732",
"pager": "",
"email": "shirley@grandcare.com"
}
]
}
}

== update ==
Updates a caregiver
=== Parameters ===
* ''id'' - [required] - ID of caregiver to update
* ''firstname'' - [optional] - First name
* ''lastname'' - [optional] - Last name
* ''email'' - [optional] - Email address
* ''address'' - [optional] - Street address
* ''city'' - [optional] - City
* ''state'' - [optional] - State
* ''zip'' - [optional] - Zip code
* ''homephone'' - [optional] - Home phone number
* ''workphone'' - [optional] - Work phone number
* ''cellphone'' - [optional] - Cell phone number
* ''pager'' - [optional] - Pager phone number

=== Results ===
Returns SUCCESS and a copy of the newly updated caregiver if successful, otherwise FAILURE. See the [[#read]] method for more information on the returned caregiver object.

== delete ==
Deletes an existing caregiver
=== Parameters ===
* ''id'' - [required] - ID of caregiver to delete

=== Results ===
Returns SUCCESS if the caregiver is deleted, otherwise FAILURE.

← Older revision		Revision as of 21:20, 11 October 2012
Line 6:		Line 6:
	* ''firstname'' - [required] - First name		* ''firstname'' - [required] - First name
	* ''lastname'' - [required] - Last name		* ''lastname'' - [required] - Last name
			* ''nickname'' - [optional] - Nick name
	* ''id'' - [optional] - Unique ID in UUID format		* ''id'' - [optional] - Unique ID in UUID format
	* ''email'' - [optional] - Email address		* ''email'' - [optional] - Email address
	* ''address'' - [optional] - Street address		* ''address'' - [optional] - Street address
			* ''address2'' - [optional] - Street address2
	* ''city'' - [optional] - City		* ''city'' - [optional] - City
	* ''state'' - [optional] - State		* ''state'' - [optional] - State / Region / Province
	* ''zip'' - [optional] - Zip code		* ''zip'' - [optional] - Zip code
			* ''country'' - [optional] - ISO3166 Country Code
	* ''homephone'' - [optional] - Home phone number		* ''homephone'' - [optional] - Home phone number
	* ''workphone'' - [optional] - Work phone number		* ''workphone'' - [optional] - Work phone number