Rest - Contacts - Volunteers - Revision history

Wikiadmin: /* Fetching a volunteers record */

2021-10-06T08:34:28Z

Fetching a volunteers record

← Older revision		Revision as of 08:34, 6 October 2021
Line 29:		Line 29:
	<TypeName>volunteers</TypeName>		<TypeName>volunteers</TypeName>
	</volunteers>		</volunteers>

			==Fetching multiple volunteer records in one call==
			It is possible to use the search endpoint to retrieve multiple records

			curl --url <Base URL>/search?PersonID[]=xxx&PersonID[]=xxx&PersonID[]=xxx& -u<username>:<password> -H Content-Type:text/xml

			Depending on how many you are fetching, you may need to use POST rather than GET

	==Searching for a volunteer record==		==Searching for a volunteer record==

Wikiadmin at 11:44, 25 November 2019

2019-11-25T11:44:59Z

← Older revision		Revision as of 11:44, 25 November 2019
Line 42:		Line 42:
	* Updated - yyyy-mm-dd		* Updated - yyyy-mm-dd
	* Archived - yyyy-mm-dd		* Archived - yyyy-mm-dd

			==Creating a volunteer record==

			Once you have created your data file, you can send it using the following:

			curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

			If there is a problem with creating that record, you will get a response containing all the errors, plus a copy of the translated data you supplied.

			If the record was created successfully, the service will return a complete reocrd for the newly created record if the attribute id set as the newly created id.

			==Updating a volunteer record==
			curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
			* id - The ID of the volunteer

			The XML should be in the same format as the create XML. However, you only need to supply fields that you wish to update. For example:
			<?xml version="1.0" encoding="utf-8"?>
			<volunteer id="100001">
			<Forename>Jane</Forename>
			<Surname>Smith</Surname>
			</volunteer>
			''The above would result in updating volunteer 1000001's Forename and Surname values''


			==Archiving a volunteer record==
			curl --url <Base URL>/<id>/archive -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<status>1</status>'
			* id - The ID of the volunteer record

			This will set the archive flag on a volunteer record. If you set the status to 0, then it will remove the archive flag.

			==Deleting a volunteer record==
			curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
			* id - The ID of the volunteer

			This should be used with great care as it will permenently delete a volunteer record.

Wikiadmin: /* Purpose */

2016-02-26T13:01:56Z

Purpose

← Older revision		Revision as of 13:01, 26 February 2016
Line 4:		Line 4:

	===Base URL===		===Base URL===
	~~http~~://app.~~views~~.~~coop~~/api/restful/contacts/volunteers		https://app.viewsapp.net/api/restful/contacts/volunteers

	===Schema===		===Schema===
	<nowiki>https://app.~~views~~.~~coop~~/api/restful/contacts/volunteers/schema(.xml\|.json\|.xsd)</nowiki>		<nowiki>https://app.viewsapp.net/api/restful/contacts/volunteers/schema(.xml\|.json\|.xsd)</nowiki>

	==Fetching a volunteers record==		==Fetching a volunteers record==

Wikiadmin: /* Schema */

2013-11-04T13:04:25Z

Schema

← Older revision		Revision as of 13:04, 4 November 2013
Line 7:		Line 7:

	===Schema===		===Schema===
	<nowiki>~~http~~://app.views.coop/api/restful/contacts/~~volunteerss~~/schema(.xml\|.json\|.xsd)</nowiki>		<nowiki>https://app.views.coop/api/restful/contacts/volunteers/schema(.xml\|.json\|.xsd)</nowiki>

	==Fetching a volunteers record==		==Fetching a volunteers record==

Wikiadmin: Created page with "==Purpose== This is a read-only API for fetching volunteers regardless of whether they are Staff Volunteers or Participant Volunteers ===Base URL=== http://app.views.coop/ap..."

2013-10-22T12:10:56Z

Created page with "==Purpose== This is a read-only API for fetching volunteers regardless of whether they are Staff Volunteers or Participant Volunteers ===Base URL=== http://app.views.coop/ap..."

New page

==Purpose==

This is a read-only API for fetching volunteers regardless of whether they are Staff Volunteers or Participant Volunteers

===Base URL===
http://app.views.coop/api/restful/contacts/volunteers

===Schema===
<nowiki>http://app.views.coop/api/restful/contacts/volunteerss/schema(.xml|.json|.xsd)</nowiki>

==Fetching a volunteers record==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will return an xml file similar to this
<?xml version="1.0" encoding="utf-8"?>
<volunteers id="100001">
<Nickname></Nickname>
<Forename>John</Forename>
<Surname>Smith</Surname>
...
<Created>2011-05-09 10:26:09</Created>
<CreatedBy>a.user</CreatedBy>
<Updated>2011-05-09 10:26:09</Updated>
<UpdatedBy>a.user</UpdatedBy>
<Archived>0000-00-00 00:00:00</Archived>
<ArchivedBy></ArchivedBy>
<Type>1</Type>
<PersonID>100001</PersonID>
<TypeName>volunteers</TypeName>
</volunteers>

==Searching for a volunteer record==
curl --url <Base URL>/search?q=<query> -u<username>:<password> -H Content-Type:text/xml
* query - This is a text string to use to search for in the volunteers records

You can search for any field for a specific value by setting the field as a parameter. Please refer to the schema for field names.

There are also a series of fields that you use -from and -to modifiers to express a range:
* DateOfBirth - yyyy-mm-dd
* Age - int (Please note that this is in days)
* Created - yyyy-mm-dd
* Updated - yyyy-mm-dd
* Archived - yyyy-mm-dd