Rest - Contacts - Participants - Revision history

Wikiadmin at 08:50, 4 April 2025

2025-04-04T08:50:10Z

← Older revision		Revision as of 08:50, 4 April 2025
Line 17:		Line 17:
	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 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.		If the record was created successfully, the service will return a complete record for the newly created record if the attribute id set as the newly created id.

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

Line 96:		Line 96:
	* id - The ID of the participant		* id - The ID of the participant

	This should be used with great care as it will ~~permenently delet~~ a participants record.		This should be used with great care as it will permanently delete a participants record.

2021-10-06T08:33:46Z

← Older revision		Revision as of 08:33, 6 October 2021
Line 45:		Line 45:
	curl --url <Base URL>/search?PersonID[]=xxx&PersonID[]=xxx&PersonID[]=xxx& -u<username>:<password> -H Content-Type:text/xml		curl --url <Base URL>/search?PersonID[]=xxx&PersonID[]=xxx&PersonID[]=xxx& -u<username>:<password> -H Content-Type:text/xml

	Depending on ~~howmany~~ you are fetching, you may need to use POST rather than GET		Depending on howm any you are fetching, you may need to use POST rather than GET

	==Searching for a participant==		==Searching for a participant==

2021-10-06T08:31:35Z

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

			==Fetching multiple partcipant 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 howmany you are fetching, you may need to use POST rather than GET

	==Searching for a participant==		==Searching for a participant==

2016-02-26T11:56:05Z

Purpose

← Older revision		Revision as of 11:56, 26 February 2016
Line 4:		Line 4:

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

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

	==Creating a participant==		==Creating a participant==

2015-07-27T08:05:25Z

← Older revision		Revision as of 08:05, 27 July 2015
Line 4:		Line 4:

	===Base URL===		===Base URL===
	~~http~~://app.views.coop/api/restful/contacts/participants		https://app.views.coop/api/restful/contacts/participants

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

	==Creating a participant==		==Creating a participant==

2014-01-30T16:35:06Z

Archiving a participant

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

	==Archiving a participant==		==Archiving a participant==
	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 participant		* id - The ID of the participant

2014-01-28T16:32:37Z

Archiving a participant

← Older revision		Revision as of 16:32, 28 January 2014
Line 80:		Line 80:

	==Archiving a participant==		==Archiving a participant==
	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 participant		* id - The ID of the participant

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


	==Deleting a participant==		==Deleting a participant==

2013-10-22T11:32:14Z

Searching for a participant

@@ Line 52: / Line 52: @@
 * Updated - yyyy-mm-dd
 * Archived - yyyy-mm-dd
 ==Updating a participant==

2012-07-09T14:25:23Z

Searching for a participant

← Older revision		Revision as of 14:25, 9 July 2012
Line 43:		Line 43:
	curl --url <Base URL>/search?q=<query> -u<username>:<password> -H Content-Type:text/xml		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 participants records		* query - This is a text string to use to search for in the participants records


	You can search for any field for a specific value by setting the field as a parameter. Please refer to the schema for fieldnames.		You can search for any field for a specific value by setting the field as a parameter. Please refer to the schema for fieldnames.
Line 53:		Line 52:
	* Updated - yyyy-mm-dd		* Updated - yyyy-mm-dd
	* Archived - yyyy-mm-dd		* Archived - yyyy-mm-dd


	==Updating a participant==		==Updating a participant==

2012-07-09T14:23:09Z

@@ Line 5: / Line 5: @@
 ===Base URL===
 http://app.views.coop/api/restful/contacts/participants
 ==Creating a participant==
 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 participants records
 ==Updating a participant==