Views API Documentation - Revision history

Wikiadmin: /* Contacts */

2025-04-04T09:16:18Z

Contacts

← Older revision		Revision as of 09:16, 4 April 2025
Line 49:		Line 49:
	** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]		** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]
	** [[Rest - Contacts - Participants - Associations\|Associations]]		** [[Rest - Contacts - Participants - Associations\|Associations]]
			* [[Rest - Contacts - Groups\|Groups]]
			** [[Rest - Contacts - Groups - Sessions\|Session Attendance]]
			** [[Rest - Contacts - Groups - Notes\|Notes]]
			** [[Rest - Contacts - Groups - Address Book\|Address Book]]
			** [[Rest - Contacts - Groups - Questionnaires\|Questionnaires]]
			** [[Rest - Contacts - Groups - Associations\|Associations]]
	* [[Rest - Contacts - Staff\|Staff]]		* [[Rest - Contacts - Staff\|Staff]]
	** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]		** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]
Line 56:		Line 62:
	** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]		** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]
	** [[Rest - Contacts - Staff - Associations\|Associations]]		** [[Rest - Contacts - Staff - Associations\|Associations]]
			* [[Rest - Contacts - Professionals\|Professionals]]
			** [[Rest - Contacts - Professionals - Sessions\|Session Attendance]]
			** [[Rest - Contacts - Professionals - Notes\|Notes]]
			** [[Rest - Contacts - Professionals - Questionnaires\|Questionnaires]]
			** [[Rest - Contacts - Professionals - Associations\|Associations]]
	* [[Rest - Contacts - Volunteers\|Volunteers]]		* [[Rest - Contacts - Volunteers\|Volunteers]]
	** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]		** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]

Wikiadmin: /* Contacts */

2022-01-17T13:57:51Z

Contacts

← Older revision		Revision as of 13:57, 17 January 2022
Line 48:		Line 48:
	** [[Rest - Contacts - Participants - Conditions\|Conditions]]		** [[Rest - Contacts - Participants - Conditions\|Conditions]]
	** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]		** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]
			** [[Rest - Contacts - Participants - Associations\|Associations]]
	* [[Rest - Contacts - Staff\|Staff]]		* [[Rest - Contacts - Staff\|Staff]]
	** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]		** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]
Line 54:		Line 55:
	** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]		** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]
	** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]		** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]
			** [[Rest - Contacts - Staff - Associations\|Associations]]
	* [[Rest - Contacts - Volunteers\|Volunteers]]		* [[Rest - Contacts - Volunteers\|Volunteers]]
	** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]		** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]

Wikiadmin: /* Using OAuth2 */

2021-09-28T08:35:27Z

Using OAuth2

← Older revision		Revision as of 08:35, 28 September 2021
Line 11:		Line 11:

	The use of OAthu2 access_tokens can be used. To do this, you must first request an <code>access_token</code> from the authentication portal https://authport.viewsapp.net/. This can be done in the following way (using Google Apps Script:		The use of OAthu2 access_tokens can be used. To do this, you must first request an <code>access_token</code> from the authentication portal https://authport.viewsapp.net/. This can be done in the following way (using Google Apps Script:
			<pre>
	// Get access_token		// Get access_token
	var response = UrlFetchApp.fetch('~~ttps~~://authportal.viewsapp.net/token.php', {		var response = UrlFetchApp.fetch('https://authportal.viewsapp.net/token.php', {
	'method' : 'post',		'method' : 'post',
	'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},		'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},
	'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}		'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}
	});		});
	var access_token = JSON.parse(response.getContentText()).access_token;		var access_token = JSON.parse(response.getContentText()).access_token;
			</pre>

	You would then pass the following fields along side any request:		You would then pass the following fields along side any request:
Line 25:		Line 26:
	* access_token=<access_token>		* access_token=<access_token>

			via curl:
			<pre>curl --url https://authportal.viewsapp.net/token.php -X POST -d "grant_type=password" -u<username>:<password> -H Accept:application/json</pre>

	====Searching the API's====		====Searching the API's====

Wikiadmin: /* Applying for access to the API */

2021-09-28T08:32:06Z

Applying for access to the API

← Older revision		Revision as of 08:32, 28 September 2021
Line 1:		Line 1:
	~~== Applying for access to the API ==~~

	~~The views API's are a restricted access service. To request access to the API's you must complete and submit the following form and someone will be in contact shortly.~~

	~~===[http://goo.gl/forms/Q0PNX5Qo1x Click here to apply]===~~

	==Rest==		==Rest==
	===General Overview===		===General Overview===

Wikiadmin: /* General Overview */

2017-06-21T13:15:33Z

General Overview

@@ Line 13: / Line 13: @@
   curl --url <Base URL>/<id>.json -u<username>:<password>
 ====Searching the API's====
@@ Line 23: / Line 43: @@
 ** By default this equals 1.
 * archived - By default, only non-archived results are returned. Setting this parameter to 1 result in searching archived records
 ===Contacts===

Wikiadmin: /* Admin */

2016-02-26T13:12:06Z

Admin

← Older revision		Revision as of 13:12, 26 February 2016
Line 73:		Line 73:
	* [[Rest - Admin - ProgrammeFields\|Programme Fields]]		* [[Rest - Admin - ProgrammeFields\|Programme Fields]]
	* [[Rest - Admin - Change Log\|Change Log]]		* [[Rest - Admin - Change Log\|Change Log]]
			* [[Rest - Admin - Flatpack\|Flatpack]]

	==SOAP Documention==		==SOAP Documention==

Wikiadmin at 13:48, 5 February 2016

2016-02-05T13:48:33Z

← Older revision		Revision as of 13:48, 5 February 2016
Line 1:		Line 1:
			== Applying for access to the API ==

			The views API's are a restricted access service. To request access to the API's you must complete and submit the following form and someone will be in contact shortly.

			===[http://goo.gl/forms/Q0PNX5Qo1x Click here to apply]===

	==Rest==		==Rest==

Wikiadmin: /* Admin */

2015-06-22T09:04:40Z

Admin

← Older revision		Revision as of 09:04, 22 June 2015
Line 67:		Line 67:
	* [[Rest - Admin - Outcomes\|Outcomes]]		* [[Rest - Admin - Outcomes\|Outcomes]]
	* [[Rest - Admin - ProgrammeFields\|Programme Fields]]		* [[Rest - Admin - ProgrammeFields\|Programme Fields]]
			* [[Rest - Admin - Change Log\|Change Log]]

	==SOAP Documention==		==SOAP Documention==

Wikiadmin: /* Contacts */

2014-02-25T10:11:01Z

Contacts

← Older revision		Revision as of 10:11, 25 February 2014
Line 27:		Line 27:
	** [[Rest - Contacts - Participants - Questionnaires\|Questionnaires]]		** [[Rest - Contacts - Participants - Questionnaires\|Questionnaires]]
	** [[Rest - Contacts - Participants - Volunteering\|Volunteering]]		** [[Rest - Contacts - Participants - Volunteering\|Volunteering]]
			** [[Rest - Contacts - Participants - Conditions\|Conditions]]
			** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]
	* [[Rest - Contacts - Staff\|Staff]]		* [[Rest - Contacts - Staff\|Staff]]
	** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]		** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]

Wikiadmin: /* Contacts */

2013-10-22T12:02:25Z

Contacts

← Older revision		Revision as of 12:02, 22 October 2013
Line 33:		Line 33:
	** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]		** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]
	** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]		** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]
	* [[Rest - Contacts - Volunteers\|Volunteers]		* [[Rest - Contacts - Volunteers\|Volunteers]]
	** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]		** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]
	** [[Rest - Contacts - Volunteers - Notes\|Notes]]		** [[Rest - Contacts - Volunteers - Notes\|Notes]]

← Older revision		Revision as of 09:16, 4 April 2025
Line 49:		Line 49:
	** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]		** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]
	** [[Rest - Contacts - Participants - Associations\|Associations]]		** [[Rest - Contacts - Participants - Associations\|Associations]]
			* [[Rest - Contacts - Groups\|Groups]]
			** [[Rest - Contacts - Groups - Sessions\|Session Attendance]]
			** [[Rest - Contacts - Groups - Notes\|Notes]]
			** [[Rest - Contacts - Groups - Address Book\|Address Book]]
			** [[Rest - Contacts - Groups - Questionnaires\|Questionnaires]]
			** [[Rest - Contacts - Groups - Associations\|Associations]]
	* [[Rest - Contacts - Staff\|Staff]]		* [[Rest - Contacts - Staff\|Staff]]
	** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]		** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]
Line 56:		Line 62:
	** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]		** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]
	** [[Rest - Contacts - Staff - Associations\|Associations]]		** [[Rest - Contacts - Staff - Associations\|Associations]]
			* [[Rest - Contacts - Professionals\|Professionals]]
			** [[Rest - Contacts - Professionals - Sessions\|Session Attendance]]
			** [[Rest - Contacts - Professionals - Notes\|Notes]]
			** [[Rest - Contacts - Professionals - Questionnaires\|Questionnaires]]
			** [[Rest - Contacts - Professionals - Associations\|Associations]]
	* [[Rest - Contacts - Volunteers\|Volunteers]]		* [[Rest - Contacts - Volunteers\|Volunteers]]
	** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]		** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]

← Older revision		Revision as of 13:57, 17 January 2022
Line 48:		Line 48:
	** [[Rest - Contacts - Participants - Conditions\|Conditions]]		** [[Rest - Contacts - Participants - Conditions\|Conditions]]
	** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]		** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]
			** [[Rest - Contacts - Participants - Associations\|Associations]]
	* [[Rest - Contacts - Staff\|Staff]]		* [[Rest - Contacts - Staff\|Staff]]
	** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]		** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]
Line 54:		Line 55:
	** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]		** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]
	** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]		** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]
			** [[Rest - Contacts - Staff - Associations\|Associations]]
	* [[Rest - Contacts - Volunteers\|Volunteers]]		* [[Rest - Contacts - Volunteers\|Volunteers]]
	** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]		** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]

← Older revision		Revision as of 10:11, 25 February 2014
Line 27:		Line 27:
	** [[Rest - Contacts - Participants - Questionnaires\|Questionnaires]]		** [[Rest - Contacts - Participants - Questionnaires\|Questionnaires]]
	** [[Rest - Contacts - Participants - Volunteering\|Volunteering]]		** [[Rest - Contacts - Participants - Volunteering\|Volunteering]]
			** [[Rest - Contacts - Participants - Conditions\|Conditions]]
			** [[Rest - Contacts - Participants - Restrictions\|Restrictions]]
	* [[Rest - Contacts - Staff\|Staff]]		* [[Rest - Contacts - Staff\|Staff]]
	** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]		** [[Rest - Contacts - Staff - Sessions\|Session Attendance]]

← Older revision		Revision as of 12:02, 22 October 2013
Line 33:		Line 33:
	** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]		** [[Rest - Contacts - Staff - Questionnaires\|Questionnaires]]
	** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]		** [[Rest - Contacts - Staff - Volunteering\|Volunteering]]
	* [[Rest - Contacts - Volunteers\|Volunteers]		* [[Rest - Contacts - Volunteers\|Volunteers]]
	** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]		** [[Rest - Contacts - Volunteers - Sessions\|Session Attendance]]
	** [[Rest - Contacts - Volunteers - Notes\|Notes]]		** [[Rest - Contacts - Volunteers - Notes\|Notes]]