Rest - Contacts - Staff - Revision history

Wikiadmin at 08:32, 6 October 2021

2021-10-06T08:32:37Z

← Older revision		Revision as of 08:32, 6 October 2021
Line 39:		Line 39:
	<TypeName>staff</TypeName>		<TypeName>staff</TypeName>
	</staff>		</staff>

			==Fetching multiple staff 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 staff record==		==Searching for a staff record==

Wikiadmin: /* Purpose */

2016-02-26T12:02:54Z

Purpose

← Older revision		Revision as of 12:02, 26 February 2016
Line 4:		Line 4:

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

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

	==Creating a staff record==		==Creating a staff record==

Wikiadmin: /* Schema */

2015-11-09T10:44:22Z

Schema

← Older revision		Revision as of 10:44, 9 November 2015
Line 7:		Line 7:

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

	==Creating a staff record==		==Creating a staff record==

Wikiadmin: /* Archiving a staff record */

2014-01-30T16:35:37Z

Archiving a staff record

← Older revision		Revision as of 16:35, 30 January 2014
Line 81:		Line 81:

	==Archiving a staff record==		==Archiving a staff record==
	curl --url <Base URL>/<id>/~~status~~ -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<status>1</status>'		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 staff record		* id - The ID of the staff record

Wikiadmin: /* Archiving a staff record */

2014-01-28T16:33:01Z

Archiving a staff record

← Older revision		Revision as of 16:33, 28 January 2014
Line 81:		Line 81:

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

Wikiadmin: /* Searching for a staff record */

2013-10-22T11:33:28Z

Searching for a staff record

← Older revision		Revision as of 11:33, 22 October 2013
Line 53:		Line 53:
	* Archived - yyyy-mm-dd		* Archived - yyyy-mm-dd


			==Searching for staff that have volunteered==
			This can be achieved by adding <code>hasvolunteeres</code> to the search method as so:

			curl --url <Base URL>/search?hasvoluteered&q=<query> -u<username>:<password> -H Content-Type:text/xml

			The default is to filter the results to those that have volunteering records, however you can negate the search results by setting this parameter to one of the following values:
			* 0
			* no
			* false

			For example:
			curl --url <Base URL>/search?hasvoluteered&q=<query> -u<username>:<password> -H Content-Type:text/xml

	==Updating a staff record==		==Updating a staff record==

Wikiadmin at 14:25, 9 July 2012

2012-07-09T14:25:00Z

@@ Line 5: / Line 5: @@
 ===Base URL===
 http://app.views.coop/api/restful/contacts/staff
 ==Creating a staff record==
 Once you have created your data file, you can send it using the following:
@@ Line 45: / Line 43: @@
   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 staff records
 ==Updating a staff record==

Wikiadmin: /* Creating a staff record */

2012-07-06T10:22:01Z

Creating a staff record

← Older revision		Revision as of 10:22, 6 July 2012
Line 8:		Line 8:
	==Creating a staff record==		==Creating a staff record==

	''As with all our services, the data structure can vary from account to account, depending how you have configured your system. To get the expected schema for the data you need to supply, you should download the schema information from: http://app.views.coop/api/restful/contacts/staffs/schema''		''As with all our services, the data structure can vary from account to account, depending how you have configured your system. To get the expected schema for the data you need to supply, you should download the schema information from:

			<nowiki>http://app.views.coop/api/restful/contacts/staffs/schema(.xml\|.json\|.xsd)</nowiki>''


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

Wikiadmin: /* Updating a staff record */

2012-04-16T11:42:17Z

Updating a staff record

← Older revision		Revision as of 11:42, 16 April 2012
Line 55:		Line 55:
	''The above would result in updating staff 1000001's Forename and Surname values''		''The above would result in updating staff 1000001's Forename and Surname values''


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

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

	==Deleting a staff record==		==Deleting a staff record==

Wikiadmin: Created page with "==Purpose== TUsed for creating, editing and deleting Staff from the Views system. ===Base URL=== http://app.views.coop/api/restful/contacts/staff ==Creating a staff record=..."

2012-04-16T10:15:46Z

Created page with "==Purpose== TUsed for creating, editing and deleting Staff from the Views system. ===Base URL=== http://app.views.coop/api/restful/contacts/staff ==Creating a staff record=..."

New page

==Purpose==

TUsed for creating, editing and deleting Staff from the Views system.

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

==Creating a staff record==

''As with all our services, the data structure can vary from account to account, depending how you have configured your system. To get the expected schema for the data you need to supply, you should download the schema information from: http://app.views.coop/api/restful/contacts/staffs/schema''

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.

==Fetching a staff 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"?>
<staff 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>staff</TypeName>
</staff>

==Searching for a staff 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 staff records

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

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"?>
<staff id="100001">
<Forename>Jane</Forename>
<Surname>Smith</Surname>
</staff>
''The above would result in updating staff 1000001's Forename and Surname values''

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

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