Views API Documentation - User contributions [en-gb]

Views API Documentation

2025-04-04T09:16:18Z

Wikiadmin: /* Contacts */

==Rest==
===General Overview===
All of our REST services are available in both XML and JSON formats, unless otherwise stated. The default format is XML. For the purposes of this documentation we only document the XML method. If you want to interact using json, then you should either make sure you request using <code>Content-Type: application/json</code>, alternatively you have append the extension <code>.json</code> to the URI e.g:
curl --url <Base URL>/<id> -u<username>:<password> -H Accept:application/json

or

curl --url <Base URL>/<id>.json -u<username>:<password>

====Using OAuth2====

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
var response = UrlFetchApp.fetch('https://authportal.viewsapp.net/token.php', {
'method' : 'post',
'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},
'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}
});
var access_token = JSON.parse(response.getContentText()).access_token;
</pre>

You would then pass the following fields along side any request:

* client_id=<username>
* 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====
A lot of the API's have a search capabilities and share some parameters:
* q=<string> - This is a free text field for basic searching
* pageFold=<int> - This the number of results to return in any result set
* offset=<int> - This is how many records to offset in the result set
* page=<int> - This can be used in place of offset as is just makes an adjustment to the offset value using the following fomula: <code>offset = (page-1)*pageFold</code>.
** ''If used in conjunction with offset, then each page is offset by the specified values also.''
** 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===
* [[Rest - Contacts - Participants|Particpants]]
** [[Rest - Contacts - Participants - Sessions|Session Attendance]]
** [[Rest - Contacts - Participants - Notes|Notes]]
** [[Rest - Contacts - Participants - Address Book|Address Book]]
** [[Rest - Contacts - Participants - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Participants - Volunteering|Volunteering]]
** [[Rest - Contacts - Participants - Conditions|Conditions]]
** [[Rest - Contacts - Participants - Restrictions|Restrictions]]
** [[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 - Sessions|Session Attendance]]
** [[Rest - Contacts - Staff - Notes|Notes]]
** [[Rest - Contacts - Staff - Address Book|Address Book]]
** [[Rest - Contacts - Staff - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Staff - Volunteering|Volunteering]]
** [[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 - Sessions|Session Attendance]]
** [[Rest - Contacts - Volunteers - Notes|Notes]]
** [[Rest - Contacts - Volunteers - Address Book|Address Book]]
** [[Rest - Contacts - Volunteers - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Volunteers - Volunteering|Volunteering]]

===Work===
* [[Rest - Work - Venues|Venues]]
* [[Rest - Work - Session Groups|Session Groups]]
** [[Rest - Work - Session Groups - Participants|Session Group Participants]]
** [[Rest - Work - Session Groups - Sessions|Sessions]]
*** [[Rest - Work - Session Groups - Session Notes|Session Notes]]
*** [[Rest - Work - Session Groups - Session Participants|Session Participants]]
*** [[Rest - Work - Session Groups - Session Staff|Session Staff]]
*** [[Rest - Work - Session Groups - Session Questionnaires|Session Questionnaires]]
* [[Rest - Work - Agency Projects|Agency Projects]]
** [[Rest - Work - Agency Projects - Session Groups|Agency Project Session Groups]]
** [[Rest - Work - Agency Projects - Objectives|Objectives]]
** [[Rest - Work - Agency Projects - Outcomes|Outcomes]]

===Evidence===
* [[Rest - Evidence - Questionnaires|Questionnaires]]
** [[Rest - Evidence - Questionnaires - Questions|Questions]]
** [[Rest - Evidence - Questionnaires - Answers|Answers]]

===Admin===
* [[Rest - Admin - Value Lists|Value Lists]]
* [[Rest - Admin - Programmes|Programmes]]
* [[Rest - Admin - Objectives|Objectives]]
* [[Rest - Admin - Outcomes|Outcomes]]
* [[Rest - Admin - ProgrammeFields|Programme Fields]]
* [[Rest - Admin - Change Log|Change Log]]
* [[Rest - Admin - Flatpack|Flatpack]]

==SOAP Documention==
===Contacts===
* [[SOAP - Contacts - Particpants|Particpants]]
* [[SOAP - Contacts - Staff|Staff]]
===Evidence===
* [[SOAP - Questionaires|Questionaires]]

Rest - Contacts - Professionals - Questionnaires

2025-04-04T09:15:30Z

Wikiadmin: Created page with "==Purpose== Used for submitting answer sets to questionnaires against professionals and for retrieving the details of answered questionnaires that have been submitted against a professional. This is only really a filtered version of the Questionnaires - Answers API ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/questionnaires</nowiki> * id - This is the professional id ===Schema===..."

==Purpose==

Used for submitting answer sets to questionnaires against professionals and for retrieving the details of answered questionnaires that have been submitted against a professional. This is only really a filtered version of the [[Rest - Evidence - Questionnaires - Answers|Questionnaires - Answers API]]

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/questionnaires</nowiki>
* id - This is the professional id

===Schema===
For details of the schemas, please refer to [[Rest - Evidence - Questionnaires - Answers]]

==Fetching a list of answer sets==
The default call will return a list of questionnaires (answer sets) that have been recorded against the professional
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="7">
<answerset id="1" questionnaireid="14">
<EntityType>Professional</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
<answerset id="4" questionnaireid="5">
<EntityType>Professional</EntityType>
<EntityID>1</EntityID>
<Date>2012-05-04T10:11:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>4</AnswerSetID>
<Questionnaire>Interests</Questionnaire>
</answerset>
...
</answersets>

If you are only interested in a particular questionnaire, you should us the following:
curl --url <Base URL>/<questionnairId> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="2">
<answerset id="1" questionnaireid="14">
<EntityType>Professional</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
<answerset id="6" questionnaireid="14">
<EntityType>Professional</EntityType>
<EntityID>1</EntityID>
<Date>2012-05-02T09:10:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>6</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
</answersets>

The results are order by the most recent first. This means to get the latest version of a questionnaire, you would only need to fetch the first result.

==Fetching the answers of a given questionnaire==
curl --url <Base URL>/<questionnairId>/<setId> -u<username>:<password> -H Content-Type:text/xml
* questionnaireId - This is the id of the questionnaire
* setId - This is the id of the Answers Set you want to retrieve

It's will return something along the lines of
<answerset questionaireid="14" id="1">
<EntityType>Professional</EntityType>
<EntityID>1</EntityID>
<TargetType/>
<TargetID>0</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answers count="9">
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
<answer id="80">
<QuestionID>80</QuestionID>
<Answer>Agree</Answer>
</answer>
...
</answers>
</answerset>

==Fetching a single answer from a questionnaire==
curl --url <Base URL>/<questionnairId>/<setId>/<questionId> -u<username>:<password> -H Content-Type:text/xml
* questionnaireId - This is the id of the questionnaire
* setId - This is the id of the Answers Set you want to retrieve
* questionId - This is the id of the question you want the answer for

<answer id="78">
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>

==Creating a new Answer Set==
curl --url <Base URL>/<questionnairId> -u<username>:<password> -H Content-Type:text/xml -X POST -d '<xml>'

To submit a new set of answers against a questionnaire, you should send data in the following structure:

<answers>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
...
</answers>

'''Note:''' If you specify the attribute ''<code>id</code>'' then you do not need to specify the <code><QuestionID></code> entity.

You can also relate the questionnaire to a Session (and SessionGroup) by specifying the <code><TargetType></code> and <code><TargetID></code> entities

<answers>
<TargetType>Session</TargetType>
<TargetID>214</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
....
</answers>

You can also omit the <code><Date></code> entity. If you do this, then the current system date/time will be used.

==Updating an existing Answer Set==
curl --url <Base URL>/<questionnairId>/<setid> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

When updating the answers in an answer set, you should use the same structure as when creating a new answer set. However, if you specify the entities <code>TargetType></code> and <code>TargetID></code> they will be ignored.

Rest - Contacts - Professionals - Notes

2025-04-04T09:13:16Z

Wikiadmin: Created page with "==Purpose== Used for creating, editing and deleting notes against a professional in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/notes</nowiki> ==Creating Notes== 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 th..."

==Purpose==

Used for creating, editing and deleting notes against a professional in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/notes</nowiki>

==Creating Notes==

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.

==Searching for a Note==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will list all notes against a professional. you can append one of the following to limit the list:
* /contact - Professional only notes
* /attendance - Professional attendance notes
* /session - Notes on sessions that the professional is registered against

By default ALL notes from the 3 categories are returned.

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

This method will only fetch Professional notes. If you attempt to fetch a note that is either of type attendance or session,
you will receive a 303 response directing you to the actual location of that note.

==Updating a Note==
''Please note'' You can only update professional notes via this api. For attendance and session notes, you should use the appropriate API.

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

The XML should be in the same format as the create, as specified by the schema

==Deleting a Note==
''Please note'' You can only update professional notes via this api. For attendance and session notes, you should use the appropriate API.
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the note

This should be used with great care as it will permanently delete a note record.

Rest - Contacts - Professionals - Sessions

2025-04-04T09:11:09Z

Wikiadmin: Created page with "==Purpose== This is a read only service. It is a search API to return sessions that a professional is associated with. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/sessions</nowiki> ==Usage== curl --url <Base URL>?q=<query> -u<username>:<password> -H Content-Type:text/xml Calling the Base URL without any parameters will return all Sessions that a professional is associated with, regardless of their attendance status. Pa..."

==Purpose==

This is a read only service. It is a search API to return sessions that a professional is associated with.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/sessions</nowiki>

==Usage==

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

Calling the Base URL without any parameters will return all Sessions that a professional is associated with, regardless of their attendance status.

Parameter:
* q - string - A string to search the results for
* SessionGroupID - int - Restrict the results to a given Session Group
* Attended - int - 1 = Attended, 0 = Registered Only

This returns something along the lines of:
<?xml version="1.0" encoding="utf-8"?>
<professional id="104240">
<sessions>
<session id="164">
<SessionID>164</SessionID>
<SessionGroupID>38</SessionGroupID>
<Title>Session 1</Title>
<Type>Individual</Type>
<StartDate>2010-10-10T12:00</StartDate>
<Duration>01:00</Duration>
<Status>Booked</Status>
<Link>/restful/work/sessiongroups/sessions/164/participants</Link>
</session>
<session id="573">
<SessionID>573</SessionID>
<SessionGroupID>7</SessionGroupID>
<Title>Session 2</Title>
<Type>Individual</Type>
<StartDate>2012-10-02T12:00</StartDate>
<Duration>01:00</Duration>
<Status>Attended</Status>
<Link>/restful/work/sessiongroups/sessions/573/participants</Link>
</session>
</sessions>
</professional>

Rest - Contacts - Groups - Questionnaires

2025-04-04T09:06:35Z

Wikiadmin: Created page with "==Purpose== Used for submitting answer sets to questionnaires against groups and for retrieving the details of answered questionnaires that have been submitted against a group. This is only really a filtered version of the Questionnaires - Answers API ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/questionnaires</nowiki> * id - This is the group id ===Schema=== For details of the schemas,..."

==Purpose==

Used for submitting answer sets to questionnaires against groups and for retrieving the details of answered questionnaires that have been submitted against a group. This is only really a filtered version of the [[Rest - Evidence - Questionnaires - Answers|Questionnaires - Answers API]]

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/questionnaires</nowiki>
* id - This is the group id

===Schema===
For details of the schemas, please refer to [[Rest - Evidence - Questionnaires - Answers]]

==Fetching a list of answer sets==
The default call will return a list of questionnaires (answer sets) that have been recorded against the group
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="7">
<answerset id="1" questionnaireid="14">
<EntityType>Group</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
<answerset id="4" questionnaireid="5">
<EntityType>Group</EntityType>
<EntityID>1</EntityID>
<Date>2012-05-04T10:11:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>4</AnswerSetID>
<Questionnaire>Interests</Questionnaire>
</answerset>
...
</answersets>

If you are only interested in a particular questionnaire, you should us the following:
curl --url <Base URL>/<questionnairId> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="2">
<answerset id="1" questionnaireid="14">
<EntityType>Group</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
<answerset id="6" questionnaireid="14">
<EntityType>Group</EntityType>
<EntityID>1</EntityID>
<Date>2012-05-02T09:10:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>6</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
</answersets>

The results are order by the most recent first. This means to get the latest version of a questionnaire, you would only need to fetch the first result.

==Fetching the answers of a given questionnaire==
curl --url <Base URL>/<questionnairId>/<setId> -u<username>:<password> -H Content-Type:text/xml
* questionnaireId - This is the id of the questionnaire
* setId - This is the id of the Answers Set you want to retrieve

It's will return something along the lines of
<answerset questionaireid="14" id="1">
<EntityType>Group</EntityType>
<EntityID>1</EntityID>
<TargetType/>
<TargetID>0</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answers count="9">
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
<answer id="80">
<QuestionID>80</QuestionID>
<Answer>Agree</Answer>
</answer>
...
</answers>
</answerset>

==Fetching a single answer from a questionnaire==
curl --url <Base URL>/<questionnairId>/<setId>/<questionId> -u<username>:<password> -H Content-Type:text/xml
* questionnaireId - This is the id of the questionnaire
* setId - This is the id of the Answers Set you want to retrieve
* questionId - This is the id of the question you want the answer for

<answer id="78">
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>

==Creating a new Answer Set==
curl --url <Base URL>/<questionnairId> -u<username>:<password> -H Content-Type:text/xml -X POST -d '<xml>'

To submit a new set of answers against a questionnaire, you should send data in the following structure:

<answers>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
...
</answers>

'''Note:''' If you specify the attribute ''<code>id</code>'' then you do not need to specify the <code><QuestionID></code> entity.

You can also relate the questionnaire to a Session (and SessionGroup) by specifying the <code><TargetType></code> and <code><TargetID></code> entities

<answers>
<TargetType>Session</TargetType>
<TargetID>214</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
....
</answers>

You can also omit the <code><Date></code> entity. If you do this, then the current system date/time will be used.

==Updating an existing Answer Set==
curl --url <Base URL>/<questionnairId>/<setid> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

When updating the answers in an answer set, you should use the same structure as when creating a new answer set. However, if you specify the entities <code>TargetType></code> and <code>TargetID></code> they will be ignored.

Rest - Contacts - Groups - Address Book

2025-04-04T09:03:29Z

Wikiadmin: Created page with "==Purpose== Used for creating, editing and deleting address book entries against a group in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/addressbook</nowiki> ===Schema=== <nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/addressbook/scheme(.xml|.json|.xsd)</nowiki> ==Creating Address Book Entries== curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>" <xml> s..."

==Purpose==

Used for creating, editing and deleting address book entries against a group in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/addressbook</nowiki>

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/addressbook/scheme(.xml|.json|.xsd)</nowiki>

==Creating Address Book Entries==

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

<xml> should be in the following format:
<entry>
<Forename>Jane</Forename>
<Surname>Smith</Surname>
<Type>Next of Kin</Type>
<Relation>Wife</Relation>
<Address1></Address1>
<Address2></Address2>
<Town>The Sticks</Town>
<County></County>
<Postcode></Postcode>
<Telephone></Telephone>
<Mobile></Mobile>
<Email></Email>
<CanCollect>1</CanCollect>
</entry>

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 record for the newly created record if the attribute id set as the newly created id.

==Listing Address Book Entries==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will list all address book entries under a group. I you wish to filter the address book to only return entries that are allowed to pick the group up from Sessions etc, then you can append the following:
* /authorisedcollectors

==Fetching an Address Book Entry==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* id - The ID of the address book entry

This will return a records similar to the following:

<?xml version="1.0" encoding="utf-8"?>
<entry id="41">
<EntryID>41</EntryID>
<ContactType>Group</ContactType>
<ContactID>100554</ContactID>
<Forename>Jane</Forename>
<Surname>Smith</Surname>
<Type>Next of Kin</Type>
<Relation>Wife</Relation>
<Address1></Address1>
<Address2></Address2>
<Town>The Sticks</Town>
<County></County>
<Postcode></Postcode>
<Telephone></Telephone>
<Mobile></Mobile>
<Email></Email>
<CanCollect>1</CanCollect>
<Created>2012-07-05 10:09:36</Created>
<CreatedBy>al.mccaig.transit</CreatedBy>
<Updated>2012-07-05 10:51:00</Updated>
<UpdatedBy>al.mccaig.transit</UpdatedBy>
</entry>

==Updating an Address Book Entry==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the address book entry

The XML should be in the same format as the create, as specified by the schema

==Deleting an Address Book Entry==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the address book entry

This should be used with great care as it will permanently delete an address book entry.

Rest - Contacts - Groups - Notes

2025-04-04T08:59:28Z

Wikiadmin: Created page with "==Purpose== Used for creating, editing and deleting notes against a group in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/notes</nowiki> ==Creating Notes== 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 c..."

==Purpose==

Used for creating, editing and deleting notes against a group in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/notes</nowiki>

==Creating Notes==

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 record for the newly created record if the attribute id set as the newly created id.

==Searching for a Note==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will list all notes against a group. you can append one of the following to limit the list:
* /contact - Group only notes
* /attendance - Group attendance notes
* /session - Notes on sessions that the group is registered against

By default ALL notes from the 3 categories are returned.

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

This method will only fetch Group notes. If you attempt to fetch a note that is either of type attendance or session,
you will receive a 303 response directing you to the actual location of that note.

==Updating a Note==
''Please note'' You can only update group notes via this api. For attendance and session notes, you should use the appropriate API.

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

The XML should be in the same format as the create, as specified by the schema

==Deleting a Note==
''Please note'' You can only update group notes via this api. For attendance and session notes, you should use the appropriate API.
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the note

This should be used with great care as it will permanently delete a note record.

Rest - Contacts - Groups - Sessions

2025-04-04T08:56:44Z

Wikiadmin: Created page with "==Purpose== This is a read only service. It is a search API to return sessions that a group is associated with. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/sessions</nowiki> ==Usage== curl --url <Base URL>?q=<query> -u<username>:<password> -H Content-Type:text/xml Calling the Base URL without any parameters will return all Sessions that a group is associated with, regardless of their attendance status. Parameter: * q - string..."

==Purpose==

This is a read only service. It is a search API to return sessions that a group is associated with.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/sessions</nowiki>

==Usage==

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

Calling the Base URL without any parameters will return all Sessions that a group is associated with, regardless of their attendance status.

Parameter:
* q - string - A string to search the results for
* SessionGroupID - int - Restrict the results to a given Session Group
* Attended - int - 1 = Attended, 0 = Registered Only

This returns something along the lines of:
<?xml version="1.0" encoding="utf-8"?>
<group id="104240">
<sessions>
<session id="164">
<SessionID>164</SessionID>
<SessionGroupID>38</SessionGroupID>
<Title>Session 1</Title>
<Type>Individual</Type>
<StartDate>2010-10-10T12:00</StartDate>
<Duration>01:00</Duration>
<Status>Booked</Status>
<Link>/restful/work/sessiongroups/sessions/164/participants</Link>
</session>
<session id="573">
<SessionID>573</SessionID>
<SessionGroupID>7</SessionGroupID>
<Title>Session 2</Title>
<Type>Individual</Type>
<StartDate>2012-10-02T12:00</StartDate>
<Duration>01:00</Duration>
<Status>Attended</Status>
<Link>/restful/work/sessiongroups/sessions/573/participants</Link>
</session>
</sessions>
</group>

Rest - Contacts - Professionals

2025-04-04T08:53:30Z

Wikiadmin: Created page with "==Purpose== Used for creating, editing and deleting Professionals from the Views system. ===Base URL=== https://app.viewsapp.net/api/restful/contacts/professionals ===Schema=== <nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/schema(.xml|.json|.xsd)</nowiki> ==Creating a professional== 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..."

==Purpose==

Used for creating, editing and deleting Professionals from the Views system.

===Base URL===
https://app.viewsapp.net/api/restful/contacts/professionals

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/schema(.xml|.json|.xsd)</nowiki>

==Creating a professional==

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 record for the newly created record if the attribute id set as the newly created id.

==Fetching a professional==
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"?>
<professional 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>16</Type>
<PersonID>100001</PersonID>
<TypeName>professional</TypeName>
</professional>

==Fetching multiple professional 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 professional==
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 professionals 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.

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

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

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

==Archiving a professional==
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 professional

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

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

This should be used with great care as it will permanently delete a professionals record.

Rest - Contacts - Participants

2025-04-04T08:50:10Z

Wikiadmin:

==Purpose==

Used for creating, editing and deleting Participants from the Views system.

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

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

==Creating a participant==

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 record for the newly created record if the attribute id set as the newly created id.

==Fetching a participant==
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"?>
<participant 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>participant</TypeName>
</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 howm any you are fetching, you may need to use POST rather than GET

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

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

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

==Searching for a participant that has 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 participant==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the participant

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

==Archiving a participant==
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

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==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the participant

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

Rest - Contacts - Groups

2025-04-04T08:44:36Z

Wikiadmin: Created page with "==Purpose== Used for creating, editing and deleting Groups from the Views system. ===Base URL=== https://app.viewsapp.net/api/restful/contacts/groups ===Schema=== <nowiki>https://app.viewsapp.net/api/restful/contacts/groups/schema(.xml|.json|.xsd)</nowiki> ==Creating a group== 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 wi..."

==Purpose==

Used for creating, editing and deleting Groups from the Views system.

===Base URL===
https://app.viewsapp.net/api/restful/contacts/groups

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/schema(.xml|.json|.xsd)</nowiki>

==Creating a group==

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 record for the newly created record if the attribute id set as the newly created id.

==Fetching a group==
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"?>
<group id="100001">
<Name>Group</Name>
...
<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>
<GroupID>100001</GroupID>
<TypeName>group</TypeName>
</group>

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

curl --url <Base URL>/search?ids[]=xxx&ids[]=xxx&ids[]=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 group==
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 groups 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.

There are also a series of fields that you use -from and -to modifiers to express a range:
* Created - yyyy-mm-dd
* Updated - yyyy-mm-dd
* Archived - yyyy-mm-dd

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

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"?>
<group id="100001">
<Name>Group</Name>
</group>
''The above would result in updating group 1000001's Name value''

==Archiving a group==
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 group

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

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

This should be used with great care as it will permanently delete a group record.

Rest - Work - Session Groups - Session Participants

2023-05-25T08:36:56Z

Wikiadmin: /* Adding multiple participants to a session */

==Purpose==

Used for administering participation by participants at sessions in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<sid>/participants</nowiki>
* '''sid''' - This is the id of the session group

==Getting the list of participants==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of participants that are associated with a session, similar to the following:
<session id="7">
<participants>
<participant id="123">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<Name>Jane Smith</Name>
<ContactType>Individual</ContactType>
<Attended>0</Attended>
<Volunteering></Volunteering>
</participant>
<participant id="102">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<Name>John Smith</Name>
<ContactType>Individual</ContactType>
<Attended>1</Attended>
<Volunteering>Made Coffee</Volunteering>
</participant>
<participants>
</sessiongroup>

==Adding Participants to a session==

===Adding participants to a bookable session===
Due to financial information being required for bookable sessions, the method of adding participants in slightly different.

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

<participant>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>

This will return errors on a fail or the full booking record on a successful submit.

The required fields are all required:
* PersonID - This is the ID of the participant
* PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is the amount paid

===Adding a single participant to a session===
You can add a single participant via the following:
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<participant>
<ContactID>101457</ContactID>
<Attended>0</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</participant>

The value for Attended is either 1 or 0, 1 = Attended. This is optional and will default to 0, unless the session has started, in which case the default is 1.

===Adding multiple participants to a session===
You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

This is an example of JSON data you must send on the server to add multiple participants

"participant": [
{"ContactID":"101457","Attended":0},
{"ContactID":"457","Attended":1, "Volunteering": "Volunteered|Made Coffee"},
{"ContactID":"57","Attended":1, "Volunteering": "Cleaned Up"}
]

This can be useful for setting a register of attending participants.

<participants>
<participant>
<ContactID>101457</ContactID>
<Attended>0</Attended>
</participant>
<participant>
<ContactID>457</ContactID>
<Attended>1</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</participant>
<participant>
<ContactID>57</ContactID>
<Attended>1</Attended>
<Volunteering>Cleaned Up</Volunteering>
</participant>
</participants>

'''''Please note:''' This will replace all existing participant data for the session''

==Removing participants from a session==

===Removing participants from a non bookable session group===

You can remove a single participant from a session via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to remove from the session via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Removing participants from a bookable session===
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to remove

By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:

<refundtype>Refund</refundtype>

or

<refundtype>Credit</refundtype>

This will result in the participants booking being completely being removed from the session

==Making payments to a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
</payment>

* PaymentType - This must be one of the following values 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is an amount in pounds.pence

==Confirming/Unconfirming a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:
<booking>
<Confirmed>1</Confirmed>
</booking>'

This can also be combined with a payment as such:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<Confirmed>1</Confirmed>
</payment>

Views API Documentation

2022-01-17T13:57:51Z

Wikiadmin: /* Contacts */

==Rest==
===General Overview===
All of our REST services are available in both XML and JSON formats, unless otherwise stated. The default format is XML. For the purposes of this documentation we only document the XML method. If you want to interact using json, then you should either make sure you request using <code>Content-Type: application/json</code>, alternatively you have append the extension <code>.json</code> to the URI e.g:
curl --url <Base URL>/<id> -u<username>:<password> -H Accept:application/json

or

curl --url <Base URL>/<id>.json -u<username>:<password>

====Using OAuth2====

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
var response = UrlFetchApp.fetch('https://authportal.viewsapp.net/token.php', {
'method' : 'post',
'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},
'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}
});
var access_token = JSON.parse(response.getContentText()).access_token;
</pre>

You would then pass the following fields along side any request:

* client_id=<username>
* 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====
A lot of the API's have a search capabilities and share some parameters:
* q=<string> - This is a free text field for basic searching
* pageFold=<int> - This the number of results to return in any result set
* offset=<int> - This is how many records to offset in the result set
* page=<int> - This can be used in place of offset as is just makes an adjustment to the offset value using the following fomula: <code>offset = (page-1)*pageFold</code>.
** ''If used in conjunction with offset, then each page is offset by the specified values also.''
** 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===
* [[Rest - Contacts - Participants|Particpants]]
** [[Rest - Contacts - Participants - Sessions|Session Attendance]]
** [[Rest - Contacts - Participants - Notes|Notes]]
** [[Rest - Contacts - Participants - Address Book|Address Book]]
** [[Rest - Contacts - Participants - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Participants - Volunteering|Volunteering]]
** [[Rest - Contacts - Participants - Conditions|Conditions]]
** [[Rest - Contacts - Participants - Restrictions|Restrictions]]
** [[Rest - Contacts - Participants - Associations|Associations]]
* [[Rest - Contacts - Staff|Staff]]
** [[Rest - Contacts - Staff - Sessions|Session Attendance]]
** [[Rest - Contacts - Staff - Notes|Notes]]
** [[Rest - Contacts - Staff - Address Book|Address Book]]
** [[Rest - Contacts - Staff - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Staff - Volunteering|Volunteering]]
** [[Rest - Contacts - Staff - Associations|Associations]]
* [[Rest - Contacts - Volunteers|Volunteers]]
** [[Rest - Contacts - Volunteers - Sessions|Session Attendance]]
** [[Rest - Contacts - Volunteers - Notes|Notes]]
** [[Rest - Contacts - Volunteers - Address Book|Address Book]]
** [[Rest - Contacts - Volunteers - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Volunteers - Volunteering|Volunteering]]

===Work===
* [[Rest - Work - Venues|Venues]]
* [[Rest - Work - Session Groups|Session Groups]]
** [[Rest - Work - Session Groups - Participants|Session Group Participants]]
** [[Rest - Work - Session Groups - Sessions|Sessions]]
*** [[Rest - Work - Session Groups - Session Notes|Session Notes]]
*** [[Rest - Work - Session Groups - Session Participants|Session Participants]]
*** [[Rest - Work - Session Groups - Session Staff|Session Staff]]
*** [[Rest - Work - Session Groups - Session Questionnaires|Session Questionnaires]]
* [[Rest - Work - Agency Projects|Agency Projects]]
** [[Rest - Work - Agency Projects - Session Groups|Agency Project Session Groups]]
** [[Rest - Work - Agency Projects - Objectives|Objectives]]
** [[Rest - Work - Agency Projects - Outcomes|Outcomes]]

===Evidence===
* [[Rest - Evidence - Questionnaires|Questionnaires]]
** [[Rest - Evidence - Questionnaires - Questions|Questions]]
** [[Rest - Evidence - Questionnaires - Answers|Answers]]

===Admin===
* [[Rest - Admin - Value Lists|Value Lists]]
* [[Rest - Admin - Programmes|Programmes]]
* [[Rest - Admin - Objectives|Objectives]]
* [[Rest - Admin - Outcomes|Outcomes]]
* [[Rest - Admin - ProgrammeFields|Programme Fields]]
* [[Rest - Admin - Change Log|Change Log]]
* [[Rest - Admin - Flatpack|Flatpack]]

==SOAP Documention==
===Contacts===
* [[SOAP - Contacts - Particpants|Particpants]]
* [[SOAP - Contacts - Staff|Staff]]
===Evidence===
* [[SOAP - Questionaires|Questionaires]]

Rest - Contacts - Groups - Associations

2022-01-17T12:26:17Z

Wikiadmin: Created page with "==Purpose== Used for viewing, creating, editing and deleting associations against a group in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/co..."

==Purpose==

Used for viewing, creating, editing and deleting associations against a group in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/groups/<id>/associations</nowiki>

==Creating Associations==
''Please note'' All parameters with * are required.

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
* associationType* - The association contact type
* associationId* - The association contactID
* association* - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

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.

==Searching for Associations==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will list all associations against a group. You can append one of the following to limit the list:
* associationType - The association contact type
* q - The search value can contain text or date in d/m/Y format [the results will be filtered by Association, Description, StartDate and EndDate columns]

By default ALL group associations are returned.

==Fetching an Association==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* id - The ID of the association

This method will only fetch Hroup association.

==Updating an Association==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the association
* association - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

The XML should be in the same format as the create, as specified by the schema

==Deleting an Association==

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

This should be used with great care as it will permanently delete the association record.

Rest - Contacts - Professionals - Associations

2022-01-17T12:25:46Z

Wikiadmin: Created page with "==Purpose== Used for viewing, creating, editing and deleting associations against a professional in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/res..."

==Purpose==

Used for viewing, creating, editing and deleting associations against a professional in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/professionals/<id>/associations</nowiki>

==Creating Associations==
''Please note'' All parameters with * are required.

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
* associationType* - The association contact type
* associationId* - The association contactID
* association* - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

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.

==Searching for Associations==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will list all associations against a professional. You can append one of the following to limit the list:
* associationType - The association contact type
* q - The search value can contain text or date in d/m/Y format [the results will be filtered by Association, Description, StartDate and EndDate columns]

By default ALL professional associations are returned.

==Fetching an Association==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* id - The ID of the association

This method will only fetch Professional association.

==Updating an Association==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the association
* association - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

The XML should be in the same format as the create, as specified by the schema

==Deleting an Association==

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

This should be used with great care as it will permanently delete the association record.

Rest - Contacts - Staff - Associations

2022-01-17T12:22:55Z

Wikiadmin: Created page with "==Purpose== Used for viewing, creating, editing and deleting associations against a staff in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/restful/co..."

==Purpose==

Used for viewing, creating, editing and deleting associations against a staff in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/staff/<id>/associations</nowiki>

==Creating Associations==
''Please note'' All parameters with * are required.

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
* associationType* - The association contact type
* associationId* - The association contactID
* association* - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

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.

==Searching for Associations==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will list all associations against a staff. You can append one of the following to limit the list:
* associationType - The association contact type
* q - The search value can contain text or date in d/m/Y format [the results will be filtered by Association, Description, StartDate and EndDate columns]

By default ALL staff associations are returned.

==Fetching an Association==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* id - The ID of the association

This method will only fetch Staff association.

==Updating an Association==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the association
* association - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

The XML should be in the same format as the create, as specified by the schema

==Deleting an Association==

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

This should be used with great care as it will permanently delete the association record.

Rest - Contacts - Participants - Associations

2022-01-17T12:21:13Z

Wikiadmin: Created page with "==Purpose== Used for viewing, creating, editing and deleting associations against a participant in the Views system. ===Base URL=== <nowiki>https://app.viewsapp.net/api/rest..."

==Purpose==

Used for viewing, creating, editing and deleting associations against a participant in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/contacts/participants/<id>/associations</nowiki>

==Creating Associations==
''Please note'' All parameters with * are required.

curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
* associationType* - The association contact type
* associationId* - The association contactID
* association* - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

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.

==Searching for Associations==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will list all associations against a participant. You can append one of the following to limit the list:
* associationType - The association contact type
* q - The search value can contain text or date in d/m/Y format [the results will be filtered by Association, Description, StartDate and EndDate columns]

By default ALL participant associations are returned.

==Fetching an Association==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* id - The ID of the association

This method will only fetch Participant association.

==Updating an Association==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the association
* association - The association
* description - The association description
* validityFrom - The association validity start date
* validityTo - The association validity end date

The XML should be in the same format as the create, as specified by the schema

==Deleting an Association==

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

This should be used with great care as it will permanently delete the association record.

Rest - Work - Session Groups - Session Notes

2021-11-09T10:52:47Z

Wikiadmin:

==Purpose==

Used for creating, editing and deleting notes against a session record in the Views system.

===Base URL===
https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<id>/notes

==Creating Sessions==

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.

==Searching for a Note==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

This will list all notes against a session

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

This will retreive a note from the views system.

==Updating a Note==
''Please note'' You can only update session record notes via this api.

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

The XML should be in the same format as the create, as specified by the schema

==Deleting a Note==
''Please note'' You can only delete session record notes via this api.
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the session

This should be used with great care as it will permanently delete a note record.

Rest - Contacts - Volunteers

2021-10-06T08:34:28Z

Wikiadmin: /* Fetching a volunteers record */

==Purpose==

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

===Base URL===
https://app.viewsapp.net/api/restful/contacts/volunteers

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/contacts/volunteers/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>

==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==
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

==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.

Rest - Contacts - Participants

2021-10-06T08:33:46Z

Wikiadmin:

==Purpose==

Used for creating, editing and deleting Participants from the Views system.

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

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

==Creating a participant==

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 partcipant==
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"?>
<participant 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>participant</TypeName>
</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 howm any you are fetching, you may need to use POST rather than GET

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

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

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

==Searching for a participant that has 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 participant==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the participant

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

==Archiving a participant==
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

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==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the participant

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

Rest - Contacts - Staff

2021-10-06T08:32:37Z

Wikiadmin:

==Purpose==

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

===Base URL===
https://app.viewsapp.net/api/restful/contacts/staff

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

==Creating a staff 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.

==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>

==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==
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

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

==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==
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''

==Archiving a staff 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 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==
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.

Rest - Contacts - Participants

2021-10-06T08:31:35Z

Wikiadmin:

==Purpose==

Used for creating, editing and deleting Participants from the Views system.

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

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

==Creating a participant==

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 partcipant==
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"?>
<participant 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>participant</TypeName>
</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==
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

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

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

==Searching for a participant that has 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 participant==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the participant

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

==Archiving a participant==
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

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==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the participant

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

Views API Documentation

2021-09-28T08:35:27Z

Wikiadmin: /* Using OAuth2 */

==Rest==
===General Overview===
All of our REST services are available in both XML and JSON formats, unless otherwise stated. The default format is XML. For the purposes of this documentation we only document the XML method. If you want to interact using json, then you should either make sure you request using <code>Content-Type: application/json</code>, alternatively you have append the extension <code>.json</code> to the URI e.g:
curl --url <Base URL>/<id> -u<username>:<password> -H Accept:application/json

or

curl --url <Base URL>/<id>.json -u<username>:<password>

====Using OAuth2====

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
var response = UrlFetchApp.fetch('https://authportal.viewsapp.net/token.php', {
'method' : 'post',
'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},
'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}
});
var access_token = JSON.parse(response.getContentText()).access_token;
</pre>

You would then pass the following fields along side any request:

* client_id=<username>
* 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====
A lot of the API's have a search capabilities and share some parameters:
* q=<string> - This is a free text field for basic searching
* pageFold=<int> - This the number of results to return in any result set
* offset=<int> - This is how many records to offset in the result set
* page=<int> - This can be used in place of offset as is just makes an adjustment to the offset value using the following fomula: <code>offset = (page-1)*pageFold</code>.
** ''If used in conjunction with offset, then each page is offset by the specified values also.''
** 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===
* [[Rest - Contacts - Participants|Particpants]]
** [[Rest - Contacts - Participants - Sessions|Session Attendance]]
** [[Rest - Contacts - Participants - Notes|Notes]]
** [[Rest - Contacts - Participants - Address Book|Address Book]]
** [[Rest - Contacts - Participants - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Participants - Volunteering|Volunteering]]
** [[Rest - Contacts - Participants - Conditions|Conditions]]
** [[Rest - Contacts - Participants - Restrictions|Restrictions]]
* [[Rest - Contacts - Staff|Staff]]
** [[Rest - Contacts - Staff - Sessions|Session Attendance]]
** [[Rest - Contacts - Staff - Notes|Notes]]
** [[Rest - Contacts - Staff - Address Book|Address Book]]
** [[Rest - Contacts - Staff - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Staff - Volunteering|Volunteering]]
* [[Rest - Contacts - Volunteers|Volunteers]]
** [[Rest - Contacts - Volunteers - Sessions|Session Attendance]]
** [[Rest - Contacts - Volunteers - Notes|Notes]]
** [[Rest - Contacts - Volunteers - Address Book|Address Book]]
** [[Rest - Contacts - Volunteers - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Volunteers - Volunteering|Volunteering]]

===Work===
* [[Rest - Work - Venues|Venues]]
* [[Rest - Work - Session Groups|Session Groups]]
** [[Rest - Work - Session Groups - Participants|Session Group Participants]]
** [[Rest - Work - Session Groups - Sessions|Sessions]]
*** [[Rest - Work - Session Groups - Session Notes|Session Notes]]
*** [[Rest - Work - Session Groups - Session Participants|Session Participants]]
*** [[Rest - Work - Session Groups - Session Staff|Session Staff]]
*** [[Rest - Work - Session Groups - Session Questionnaires|Session Questionnaires]]
* [[Rest - Work - Agency Projects|Agency Projects]]
** [[Rest - Work - Agency Projects - Session Groups|Agency Project Session Groups]]
** [[Rest - Work - Agency Projects - Objectives|Objectives]]
** [[Rest - Work - Agency Projects - Outcomes|Outcomes]]

===Evidence===
* [[Rest - Evidence - Questionnaires|Questionnaires]]
** [[Rest - Evidence - Questionnaires - Questions|Questions]]
** [[Rest - Evidence - Questionnaires - Answers|Answers]]

===Admin===
* [[Rest - Admin - Value Lists|Value Lists]]
* [[Rest - Admin - Programmes|Programmes]]
* [[Rest - Admin - Objectives|Objectives]]
* [[Rest - Admin - Outcomes|Outcomes]]
* [[Rest - Admin - ProgrammeFields|Programme Fields]]
* [[Rest - Admin - Change Log|Change Log]]
* [[Rest - Admin - Flatpack|Flatpack]]

==SOAP Documention==
===Contacts===
* [[SOAP - Contacts - Particpants|Particpants]]
* [[SOAP - Contacts - Staff|Staff]]
===Evidence===
* [[SOAP - Questionaires|Questionaires]]

Views API Documentation

2021-09-28T08:32:06Z

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

==Rest==
===General Overview===
All of our REST services are available in both XML and JSON formats, unless otherwise stated. The default format is XML. For the purposes of this documentation we only document the XML method. If you want to interact using json, then you should either make sure you request using <code>Content-Type: application/json</code>, alternatively you have append the extension <code>.json</code> to the URI e.g:
curl --url <Base URL>/<id> -u<username>:<password> -H Accept:application/json

or

curl --url <Base URL>/<id>.json -u<username>:<password>

====Using OAuth2====

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:

// Get access_token
var response = UrlFetchApp.fetch('ttps://authportal.viewsapp.net/token.php', {
'method' : 'post',
'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},
'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}
});
var access_token = JSON.parse(response.getContentText()).access_token;

You would then pass the following fields along side any request:

* client_id=<username>
* access_token=<access_token>

====Searching the API's====
A lot of the API's have a search capabilities and share some parameters:
* q=<string> - This is a free text field for basic searching
* pageFold=<int> - This the number of results to return in any result set
* offset=<int> - This is how many records to offset in the result set
* page=<int> - This can be used in place of offset as is just makes an adjustment to the offset value using the following fomula: <code>offset = (page-1)*pageFold</code>.
** ''If used in conjunction with offset, then each page is offset by the specified values also.''
** 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===
* [[Rest - Contacts - Participants|Particpants]]
** [[Rest - Contacts - Participants - Sessions|Session Attendance]]
** [[Rest - Contacts - Participants - Notes|Notes]]
** [[Rest - Contacts - Participants - Address Book|Address Book]]
** [[Rest - Contacts - Participants - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Participants - Volunteering|Volunteering]]
** [[Rest - Contacts - Participants - Conditions|Conditions]]
** [[Rest - Contacts - Participants - Restrictions|Restrictions]]
* [[Rest - Contacts - Staff|Staff]]
** [[Rest - Contacts - Staff - Sessions|Session Attendance]]
** [[Rest - Contacts - Staff - Notes|Notes]]
** [[Rest - Contacts - Staff - Address Book|Address Book]]
** [[Rest - Contacts - Staff - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Staff - Volunteering|Volunteering]]
* [[Rest - Contacts - Volunteers|Volunteers]]
** [[Rest - Contacts - Volunteers - Sessions|Session Attendance]]
** [[Rest - Contacts - Volunteers - Notes|Notes]]
** [[Rest - Contacts - Volunteers - Address Book|Address Book]]
** [[Rest - Contacts - Volunteers - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Volunteers - Volunteering|Volunteering]]

===Work===
* [[Rest - Work - Venues|Venues]]
* [[Rest - Work - Session Groups|Session Groups]]
** [[Rest - Work - Session Groups - Participants|Session Group Participants]]
** [[Rest - Work - Session Groups - Sessions|Sessions]]
*** [[Rest - Work - Session Groups - Session Notes|Session Notes]]
*** [[Rest - Work - Session Groups - Session Participants|Session Participants]]
*** [[Rest - Work - Session Groups - Session Staff|Session Staff]]
*** [[Rest - Work - Session Groups - Session Questionnaires|Session Questionnaires]]
* [[Rest - Work - Agency Projects|Agency Projects]]
** [[Rest - Work - Agency Projects - Session Groups|Agency Project Session Groups]]
** [[Rest - Work - Agency Projects - Objectives|Objectives]]
** [[Rest - Work - Agency Projects - Outcomes|Outcomes]]

===Evidence===
* [[Rest - Evidence - Questionnaires|Questionnaires]]
** [[Rest - Evidence - Questionnaires - Questions|Questions]]
** [[Rest - Evidence - Questionnaires - Answers|Answers]]

===Admin===
* [[Rest - Admin - Value Lists|Value Lists]]
* [[Rest - Admin - Programmes|Programmes]]
* [[Rest - Admin - Objectives|Objectives]]
* [[Rest - Admin - Outcomes|Outcomes]]
* [[Rest - Admin - ProgrammeFields|Programme Fields]]
* [[Rest - Admin - Change Log|Change Log]]
* [[Rest - Admin - Flatpack|Flatpack]]

==SOAP Documention==
===Contacts===
* [[SOAP - Contacts - Particpants|Particpants]]
* [[SOAP - Contacts - Staff|Staff]]
===Evidence===
* [[SOAP - Questionaires|Questionaires]]

Rest - Admin - Value Lists

2020-09-21T06:59:59Z

Wikiadmin: /* Fetching a Value List */

==Purpose==

Used for maintaining the value lists within Views.

===Base URL===
https://app.viewsapp.net/api/restful/admin/valuelists

==Retrieve a list of available value lists==
curl --url <Base URL>?type=<type>&mode=<mode> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

* type '''required''' - This must be one of the following values:
*# Staff
*# Volunteer
*# Individual
*# Person
*# Group
*# Session
*# SessionGroup
*# Question
*# Agency
*# Venue
*# QualificationProgress
*# QualificationAchievement
*# AddressBook
*# Report
* mode - this can be left blank to return a complete list, or one of the following values:
*# editable - filters the returned value lists that are allowed to be extended
*# nonsystem - filters the returned value lists to only Non System lists

==Retreive the details of a Value List==

curl --url <Base URL>/<id>/details -u<username>:<password> -H Content-Type:text/xml
* '''id''' - The ID of the Value List

This will return all the meta data about a Value list. '''''Needs more detail'''''

==Fetching a Value List==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* '''id''' - The ID of the Value List

This will return an xml file similar to the following:
<?xml version="1.0" encoding="utf-8"?>
<valuelist id="42" count="4" archived-items="2">
<items>
<item id="7">Red</item>
<item id="18">Green</item>
<item id="19">Blue</item>
<item id="25">Purple</item>
</items>
</valuelist>

==Returning Archived Values==

If an additional parameter '''include-archived=1''' is passed then the following would be output:

<?xml version="1.0" encoding="utf-8"?>
<valuelist id="42" count="6" archived-items="2">
<items>
<item id="7">Red</item>
<item id="18">Green</item>
<item id="19">Blue</item>
<item id="25">Purple</item>
<item id="26" archived="true">Orange</item>
<item id="27" archived="true">White</item>
</items>
</valuelist>

==Fetching a Value List By Name==

curl --url <Base URL>/<type>/<name> -u<username>:<password> -H Content-Type:text/xml
* '''type''' - This is the type of the Value List. This must be one of the values stated above
* '''name''' - The name of the Value List

This will return an xml file in the same format as fetching a list by id

For eaxample, the following call will get a list of session group volunteering types:

curl --url <Base URL>/sessiongroup/volunteeringtypes -u<username>:<password> -H Content-Type:text/xml

Rest - Contacts - Volunteers

2019-11-25T11:44:59Z

Wikiadmin:

==Purpose==

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

===Base URL===
https://app.viewsapp.net/api/restful/contacts/volunteers

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/contacts/volunteers/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

==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.

Rest - Work - Session Groups - Participants

2019-03-18T12:24:01Z

Wikiadmin: Keeping docs up to date with API changes in 5052

==Purpose==

Used for administering participant registrations on session groups in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/<sid>/participants</nowiki>
* '''sid''' - This is the id of the session group

'''Note:''' If the Session Group has been archived, this API becomes read only.''

==Getting the list of participants==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of participants that are associated wit the session group, similar to the following:
<sessiongroup id="7">
<participants>
<participant id="123">
<Name>Jane Smith</Name>
<Type>1</Type>
<Attended/>
<FirstAttended/>
<Nickname/>
<Forename>Jane</Forename>
<Surname>Smith</Surname>
...
<EngagmentLevel>0</EngagmentLevel>
<EngagmentLevelName>Not Set</EngagmentLevelName>
</participant>
<participant id="102">
<Name>John Smith</Name>
<Type>1</Type>
<Attended/>
<FirstAttended/>
<Nickname/>
<Forename>john</Forename>
<Surname>Smith</Surname>
...
<EngagmentLevel>0</EngagmentLevel>
<EngagmentLevelName>Not Set
</EngagmentLevelName>
</participant>
<participants>
</sessiongroup>

'''Note:''' If the Session Group is bookable, each participant record will also contain a booking object as well.

==Adding participants to a session group==
===Adding participants to a non-bookable session group===
You can add a single participant via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X POST
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Adding participants to a bookable session groups===
Due to financial information being required for bookable session groups the method of adding participants in slightly different.

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

<participant>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Confirmed>1</Confirmed>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>

This will return errors on a fail or the full booking record on a successful submit.

The required fields are all required:
* PersonID - This is the ID of the participant
* PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is the amount paid

'''''Note:''''' If the Booking Mode is Session, then you will be required to pass an extra <code>SessionID</code> element. For example:
<participant>
<SessionID>776</SessionID>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Confirmed>1</Confirmed>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>
'' It is prefered that you use the [[Rest - Work - Session Groups - Session Participants|Session Participants]] API ''

==Removing participants from a session group==
===Removing participants from a non bookable session group===
You can remove a single participant from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to remove from the session group via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

In either case server will respond in such format with status for each individual participant:

<work>
<participant id="1">Does not exist</participant>
<participant id="2">Deleted</participant>
<participant id="3">Archived</participant>
</work>

'''''Note:''''' If participant has attended a Session within target Session Group and therefore can't be removed from Session Group register - his record will be archived.

===Removing participants from a bookable session group===
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to remove

By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:

<refundtype>Refund</refundtype>

or

<refundtype>Credit</refundtype>

This will result in the participants booking being completely being removed from the session group

==Making payments to a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
</payment>

* PaymentType - This must be one of the following values 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is an amount in pounds.pence

==Confirming/Unconfirming a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:
<booking>
<Confirmed>1</Confirmed>
</booking>'

This can also be combined with a payment as such:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<Confirmed>1</Confirmed>
</payment>

Rest - Work - Session Groups - Session Participants

2018-02-01T12:39:58Z

Wikiadmin: /* Removing participants from a bookable session */

==Purpose==

Used for administering participation by participants at sessions in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<sid>/participants</nowiki>
* '''sid''' - This is the id of the session group

==Getting the list of participants==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of participants that are associated with a session, similar to the following:
<session id="7">
<participants>
<participant id="123">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<Name>Jane Smith</Name>
<ContactType>Individual</ContactType>
<Attended>0</Attended>
<Volunteering></Volunteering>
</participant>
<participant id="102">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<Name>John Smith</Name>
<ContactType>Individual</ContactType>
<Attended>1</Attended>
<Volunteering>Made Coffee</Volunteering>
</participant>
<participants>
</sessiongroup>

==Adding Participants to a session==

===Adding participants to a bookable session===
Due to financial information being required for bookable sessions, the method of adding participants in slightly different.

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

<participant>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>

This will return errors on a fail or the full booking record on a successful submit.

The required fields are all required:
* PersonID - This is the ID of the participant
* PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is the amount paid

===Adding a single participant to a session===
You can add a single participant via the following:
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<participant>
<ContactID>101457</ContactID>
<Attended>0</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</participant>

The value for Attended is either 1 or 0, 1 = Attended. This is optional and will default to 0, unless the session has started, in which case the default is 1.

===Adding multiple participants to a session===
You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

This can be useful for setting a register of attending participants.

<participants>
<participant>
<ContactID>101457</ContactID>
<Attended>0</Attended>
</participant>
<participant>
<ContactID>457</ContactID>
<Attended>1</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</participant>
<participant>
<ContactID>57</ContactID>
<Attended>1</Attended>
<Volunteering>Cleaned Up</Volunteering>
</participant>
</participants>

'''''Please note:''' This will replace all existing participant data for the session''

==Removing participants from a session==

===Removing participants from a non bookable session group===

You can remove a single participant from a session via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to remove from the session via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Removing participants from a bookable session===
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to remove

By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:

<refundtype>Refund</refundtype>

or

<refundtype>Credit</refundtype>

This will result in the participants booking being completely being removed from the session

==Making payments to a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
</payment>

* PaymentType - This must be one of the following values 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is an amount in pounds.pence

==Confirming/Unconfirming a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:
<booking>
<Confirmed>1</Confirmed>
</booking>'

This can also be combined with a payment as such:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<Confirmed>1</Confirmed>
</payment>

Rest - Work - Session Groups - Participants

2018-02-01T12:38:01Z

Wikiadmin: /* Adding participants to a bookable session groups */

==Purpose==

Used for administering participant registrations on session groups in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/<sid>/participants</nowiki>
* '''sid''' - This is the id of the session group

'''Note:''' If the Session Group has been archived, this API becomes read only.''

==Getting the list of participants==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of participants that are associated wit the session group, similar to the following:
<sessiongroup id="7">
<participants>
<participant id="123">
<Name>Jane Smith</Name>
<Type>1</Type>
<Attended/>
<FirstAttended/>
<Nickname/>
<Forename>Jane</Forename>
<Surname>Smith</Surname>
...
<EngagmentLevel>0</EngagmentLevel>
<EngagmentLevelName>Not Set</EngagmentLevelName>
</participant>
<participant id="102">
<Name>John Smith</Name>
<Type>1</Type>
<Attended/>
<FirstAttended/>
<Nickname/>
<Forename>john</Forename>
<Surname>Smith</Surname>
...
<EngagmentLevel>0</EngagmentLevel>
<EngagmentLevelName>Not Set
</EngagmentLevelName>
</participant>
<participants>
</sessiongroup>

'''Note:''' If the Session Group is bookable, each participant record will also contain a booking object as well.

==Adding participants to a session group==
===Adding participants to a non-bookable session group===
You can add a single participant via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X POST
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Adding participants to a bookable session groups===
Due to financial information being required for bookable session groups the method of adding participants in slightly different.

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

<participant>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Confirmed>1</Confirmed>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>

This will return errors on a fail or the full booking record on a successful submit.

The required fields are all required:
* PersonID - This is the ID of the participant
* PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is the amount paid

'''''Note:''''' If the Booking Mode is Session, then you will be required to pass an extra <code>SessionID</code> element. For example:
<participant>
<SessionID>776</SessionID>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Confirmed>1</Confirmed>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>
'' It is prefered that you use the [[Rest - Work - Session Groups - Session Participants|Session Participants]] API ''

==Removing participants from a session group==
===Removing participants from a non bookable session group===
You can remove a single participant from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to remove from the session group via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Removing participants from a bookable session group===
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to remove

By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:

<refundtype>Refund</refundtype>

or

<refundtype>Credit</refundtype>

This will result in the participants booking being completely being removed from the session group

==Making payments to a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
</payment>

* PaymentType - This must be one of the following values 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is an amount in pounds.pence

==Confirming/Unconfirming a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:
<booking>
<Confirmed>1</Confirmed>
</booking>'

This can also be combined with a payment as such:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<Confirmed>1</Confirmed>
</payment>

Rest - Work - Session Groups - Participants

2018-02-01T12:33:28Z

Wikiadmin: /* Making payments to a booking */

==Purpose==

Used for administering participant registrations on session groups in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/<sid>/participants</nowiki>
* '''sid''' - This is the id of the session group

'''Note:''' If the Session Group has been archived, this API becomes read only.''

==Getting the list of participants==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of participants that are associated wit the session group, similar to the following:
<sessiongroup id="7">
<participants>
<participant id="123">
<Name>Jane Smith</Name>
<Type>1</Type>
<Attended/>
<FirstAttended/>
<Nickname/>
<Forename>Jane</Forename>
<Surname>Smith</Surname>
...
<EngagmentLevel>0</EngagmentLevel>
<EngagmentLevelName>Not Set</EngagmentLevelName>
</participant>
<participant id="102">
<Name>John Smith</Name>
<Type>1</Type>
<Attended/>
<FirstAttended/>
<Nickname/>
<Forename>john</Forename>
<Surname>Smith</Surname>
...
<EngagmentLevel>0</EngagmentLevel>
<EngagmentLevelName>Not Set
</EngagmentLevelName>
</participant>
<participants>
</sessiongroup>

'''Note:''' If the Session Group is bookable, each participant record will also contain a booking object as well.

==Adding participants to a session group==
===Adding participants to a non-bookable session group===
You can add a single participant via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X POST
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Adding participants to a bookable session groups===
Due to financial information being required for bookable session groups the method of adding participants in slightly different.

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

<participant>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>

This will return errors on a fail or the full booking record on a successful submit.

The required fields are all required:
* PersonID - This is the ID of the participant
* PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is the amount paid

'''''Note:''''' If the Booking Mode is Session, then you will be required to pass an extra <code>SessionID</code> element. For example:
<participant>
<SessionID>776</SessionID>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>
'' It is prefered that you use the [[Rest - Work - Session Groups - Session Participants|Session Participants]] API ''

==Removing participants from a session group==
===Removing participants from a non bookable session group===
You can remove a single participant from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to remove from the session group via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Removing participants from a bookable session group===
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to remove

By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:

<refundtype>Refund</refundtype>

or

<refundtype>Credit</refundtype>

This will result in the participants booking being completely being removed from the session group

==Making payments to a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
</payment>

* PaymentType - This must be one of the following values 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is an amount in pounds.pence

==Confirming/Unconfirming a booking==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

* *id* - This is the participant id

The data for submitting a payment record is currently quite basic. It is our intention to expand on this:
<booking>
<Confirmed>1</Confirmed>
</booking>'

This can also be combined with a payment as such:

<payment>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<Confirmed>1</Confirmed>
</payment>

Views API Documentation

2017-06-21T13:15:33Z

Wikiadmin: /* General Overview */

== 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==
===General Overview===
All of our REST services are available in both XML and JSON formats, unless otherwise stated. The default format is XML. For the purposes of this documentation we only document the XML method. If you want to interact using json, then you should either make sure you request using <code>Content-Type: application/json</code>, alternatively you have append the extension <code>.json</code> to the URI e.g:
curl --url <Base URL>/<id> -u<username>:<password> -H Accept:application/json

or

curl --url <Base URL>/<id>.json -u<username>:<password>

====Using OAuth2====

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:

// Get access_token
var response = UrlFetchApp.fetch('ttps://authportal.viewsapp.net/token.php', {
'method' : 'post',
'payload' : {'grant_type': 'password', 'username' : 'my_username', 'password' : 'my_password'},
'headers' : {"Authorization": "Basic " + Utilities.base64Encode('my_username' + ":" + 'my_password')}
});
var access_token = JSON.parse(response.getContentText()).access_token;

You would then pass the following fields along side any request:

* client_id=<username>
* access_token=<access_token>

====Searching the API's====
A lot of the API's have a search capabilities and share some parameters:
* q=<string> - This is a free text field for basic searching
* pageFold=<int> - This the number of results to return in any result set
* offset=<int> - This is how many records to offset in the result set
* page=<int> - This can be used in place of offset as is just makes an adjustment to the offset value using the following fomula: <code>offset = (page-1)*pageFold</code>.
** ''If used in conjunction with offset, then each page is offset by the specified values also.''
** 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===
* [[Rest - Contacts - Participants|Particpants]]
** [[Rest - Contacts - Participants - Sessions|Session Attendance]]
** [[Rest - Contacts - Participants - Notes|Notes]]
** [[Rest - Contacts - Participants - Address Book|Address Book]]
** [[Rest - Contacts - Participants - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Participants - Volunteering|Volunteering]]
** [[Rest - Contacts - Participants - Conditions|Conditions]]
** [[Rest - Contacts - Participants - Restrictions|Restrictions]]
* [[Rest - Contacts - Staff|Staff]]
** [[Rest - Contacts - Staff - Sessions|Session Attendance]]
** [[Rest - Contacts - Staff - Notes|Notes]]
** [[Rest - Contacts - Staff - Address Book|Address Book]]
** [[Rest - Contacts - Staff - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Staff - Volunteering|Volunteering]]
* [[Rest - Contacts - Volunteers|Volunteers]]
** [[Rest - Contacts - Volunteers - Sessions|Session Attendance]]
** [[Rest - Contacts - Volunteers - Notes|Notes]]
** [[Rest - Contacts - Volunteers - Address Book|Address Book]]
** [[Rest - Contacts - Volunteers - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Volunteers - Volunteering|Volunteering]]

===Work===
* [[Rest - Work - Venues|Venues]]
* [[Rest - Work - Session Groups|Session Groups]]
** [[Rest - Work - Session Groups - Participants|Session Group Participants]]
** [[Rest - Work - Session Groups - Sessions|Sessions]]
*** [[Rest - Work - Session Groups - Session Notes|Session Notes]]
*** [[Rest - Work - Session Groups - Session Participants|Session Participants]]
*** [[Rest - Work - Session Groups - Session Staff|Session Staff]]
*** [[Rest - Work - Session Groups - Session Questionnaires|Session Questionnaires]]
* [[Rest - Work - Agency Projects|Agency Projects]]
** [[Rest - Work - Agency Projects - Session Groups|Agency Project Session Groups]]
** [[Rest - Work - Agency Projects - Objectives|Objectives]]
** [[Rest - Work - Agency Projects - Outcomes|Outcomes]]

===Evidence===
* [[Rest - Evidence - Questionnaires|Questionnaires]]
** [[Rest - Evidence - Questionnaires - Questions|Questions]]
** [[Rest - Evidence - Questionnaires - Answers|Answers]]

===Admin===
* [[Rest - Admin - Value Lists|Value Lists]]
* [[Rest - Admin - Programmes|Programmes]]
* [[Rest - Admin - Objectives|Objectives]]
* [[Rest - Admin - Outcomes|Outcomes]]
* [[Rest - Admin - ProgrammeFields|Programme Fields]]
* [[Rest - Admin - Change Log|Change Log]]
* [[Rest - Admin - Flatpack|Flatpack]]

==SOAP Documention==
===Contacts===
* [[SOAP - Contacts - Particpants|Particpants]]
* [[SOAP - Contacts - Staff|Staff]]
===Evidence===
* [[SOAP - Questionaires|Questionaires]]

Rest - Admin - Flatpack

2016-02-26T13:12:28Z

Wikiadmin: /* Base URL */

==Purpose==
To automate and retrieve flatpack archives from views

===Base URL===
https://app.viewsapp.net/api/restful/admin/flatpack

==Get a list of available blocks==

curl --url <Base URL>/getblocks(.json|xml) -u<username>:<password>

These are the objects can be packed into a flatpack. By default all available data is stored within the flatpack

<?xml version="1.0" encoding="UTF-8"?>
<admin>
<flatpackblocks>
<flatpackblock id="0">reports</flatpackblock>
<flatpackblock id="1">agencyProject</flatpackblock>
<flatpackblock id="2">caseStudies</flatpackblock>
<flatpackblock id="3">finance</flatpackblock>
<flatpackblock id="4">group</flatpackblock>
<flatpackblock id="5">media</flatpackblock>
<flatpackblock id="6">note</flatpackblock>
<flatpackblock id="7">objectives</flatpackblock>
<flatpackblock id="8">outcomes</flatpackblock>
<flatpackblock id="9">personCondition</flatpackblock>
<flatpackblock id="10">personContact</flatpackblock>
<flatpackblock id="11">personQualifications</flatpackblock>
<flatpackblock id="12">personRestriction</flatpackblock>
<flatpackblock id="13">questionnaireAnswers</flatpackblock>
<flatpackblock id="14">questionnaire</flatpackblock>
<flatpackblock id="15">questionsData</flatpackblock>
<flatpackblock id="16">reportsPublished</flatpackblock>
<flatpackblock id="17">session</flatpackblock>
<flatpackblock id="18">sessionGroup</flatpackblock>
<flatpackblock id="19">sessionStaffAttendance</flatpackblock>
<flatpackblock id="20">stock</flatpackblock>
<flatpackblock id="21">stockCategory</flatpackblock>
<flatpackblock id="22">stockLoan</flatpackblock>
<flatpackblock id="23">venue</flatpackblock>
<flatpackblock id="24">personTypePerson</flatpackblock>
<flatpackblock id="25">personTypeStaff</flatpackblock>
<flatpackblock id="26">personTypeVolunteer</flatpackblock>
<flatpackblock id="27">personTypeProfessional</flatpackblock>
<flatpackblock id="28">sessionAttendance</flatpackblock>
</flatpackblocks>
</admin>

'''''Note 1:''' The list above may vary from agency to agency''

'''''Note 2:''' The id's in the resulting XML data are irrelevant and can be ignored''

==Generate a Flatpack==

curl --url <Base URL>/<file> -u<username>:<password> -XPOST [--data "<xml>"]

This will generate a new flatpack, if one does not already exist. If not data is posted to the API, the the flatpack is generated with all the available blocks.
To restrict the data within the flatpack archive, you should pass a list of blocks you want:

<flatpackblocks>
<flatpackblock>personTypePerson</flatpackblock>
<flatpackblock>personTypeStaff</flatpackblock>
<flatpackblock>personTypeVolunteer</flatpackblock>
<flatpackblock>personTypeProfessional</flatpackblock>
<flatpackblock>sessionAttendance</flatpackblock>
</flatpackblocks>

==Listing available Flatpacks==

curl --url <Base URL>/list(.json|xml) -u<username>:<password>

<?xml version="1.0" encoding="UTF-8"?>
<admin>
<flatpacks>
<flatpack id="0">
<file>flatpack20160113.zip</file>
<date>13/01/2016</date>
<size>1100021</size>
<sha1sum>2b77ba54249c7a25f4a05be2b9a7c28a5fe9071f</sha1sum>
</flatpack>
<flatpack id="1">
<file>flatpack20160112.zip</file>
<date>2016-01-12</date>
<size>1099668</size>
<sha1sum>68eac14b20480b9e77f599b8685307153e3f43db</sha1sum>
</flatpack>
</flatpacks>
</admin>

'''''Note:''' The id's in the resulting XML data are irrelevant and can be ignored''

==Downloading a Flatpack==

curl --url <Base URL>/<file> -u<username>:<password>

This will download a the flatpack zip file requested.

==Deleting Flatpacks / House keeping==

This is currently not implemented. Please contact us if you need this

Views API Documentation

2016-02-26T13:12:06Z

Wikiadmin: /* Admin */

== 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==
===General Overview===
All of our REST services are available in both XML and JSON formats, unless otherwise stated. The default format is XML. For the purposes of this documentation we only document the XML method. If you want to interact using json, then you should either make sure you request using <code>Content-Type: application/json</code>, alternatively you have append the extension <code>.json</code> to the URI e.g:
curl --url <Base URL>/<id> -u<username>:<password> -H Accept:application/json

or

curl --url <Base URL>/<id>.json -u<username>:<password>

====Searching the API's====
A lot of the API's have a search capabilities and share some parameters:
* q=<string> - This is a free text field for basic searching
* pageFold=<int> - This the number of results to return in any result set
* offset=<int> - This is how many records to offset in the result set
* page=<int> - This can be used in place of offset as is just makes an adjustment to the offset value using the following fomula: <code>offset = (page-1)*pageFold</code>.
** ''If used in conjunction with offset, then each page is offset by the specified values also.''
** 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===
* [[Rest - Contacts - Participants|Particpants]]
** [[Rest - Contacts - Participants - Sessions|Session Attendance]]
** [[Rest - Contacts - Participants - Notes|Notes]]
** [[Rest - Contacts - Participants - Address Book|Address Book]]
** [[Rest - Contacts - Participants - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Participants - Volunteering|Volunteering]]
** [[Rest - Contacts - Participants - Conditions|Conditions]]
** [[Rest - Contacts - Participants - Restrictions|Restrictions]]
* [[Rest - Contacts - Staff|Staff]]
** [[Rest - Contacts - Staff - Sessions|Session Attendance]]
** [[Rest - Contacts - Staff - Notes|Notes]]
** [[Rest - Contacts - Staff - Address Book|Address Book]]
** [[Rest - Contacts - Staff - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Staff - Volunteering|Volunteering]]
* [[Rest - Contacts - Volunteers|Volunteers]]
** [[Rest - Contacts - Volunteers - Sessions|Session Attendance]]
** [[Rest - Contacts - Volunteers - Notes|Notes]]
** [[Rest - Contacts - Volunteers - Address Book|Address Book]]
** [[Rest - Contacts - Volunteers - Questionnaires|Questionnaires]]
** [[Rest - Contacts - Volunteers - Volunteering|Volunteering]]

===Work===
* [[Rest - Work - Venues|Venues]]
* [[Rest - Work - Session Groups|Session Groups]]
** [[Rest - Work - Session Groups - Participants|Session Group Participants]]
** [[Rest - Work - Session Groups - Sessions|Sessions]]
*** [[Rest - Work - Session Groups - Session Notes|Session Notes]]
*** [[Rest - Work - Session Groups - Session Participants|Session Participants]]
*** [[Rest - Work - Session Groups - Session Staff|Session Staff]]
*** [[Rest - Work - Session Groups - Session Questionnaires|Session Questionnaires]]
* [[Rest - Work - Agency Projects|Agency Projects]]
** [[Rest - Work - Agency Projects - Session Groups|Agency Project Session Groups]]
** [[Rest - Work - Agency Projects - Objectives|Objectives]]
** [[Rest - Work - Agency Projects - Outcomes|Outcomes]]

===Evidence===
* [[Rest - Evidence - Questionnaires|Questionnaires]]
** [[Rest - Evidence - Questionnaires - Questions|Questions]]
** [[Rest - Evidence - Questionnaires - Answers|Answers]]

===Admin===
* [[Rest - Admin - Value Lists|Value Lists]]
* [[Rest - Admin - Programmes|Programmes]]
* [[Rest - Admin - Objectives|Objectives]]
* [[Rest - Admin - Outcomes|Outcomes]]
* [[Rest - Admin - ProgrammeFields|Programme Fields]]
* [[Rest - Admin - Change Log|Change Log]]
* [[Rest - Admin - Flatpack|Flatpack]]

==SOAP Documention==
===Contacts===
* [[SOAP - Contacts - Particpants|Particpants]]
* [[SOAP - Contacts - Staff|Staff]]
===Evidence===
* [[SOAP - Questionaires|Questionaires]]

Rest - Admin - Change Log

2016-02-26T13:11:01Z

Wikiadmin:

==Purpose==

The intention of this API is to allow a system to keep in sync with the views server or trigger custom actions on data changes.

'''Please note:''' ''This API is still in development. While this API is stable and '''all''' the methods documented on this page will be improved rather than than changed, it will be with checking back with this documentation prior to any new interactions with this API.''

===Base URL===
https://app.viewsapp.net/api/restful/admin/changelog

==Basic Usage==

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

This will return something similar to:
<?xml version="1.0" encoding="utf-8"?>
<changelog>
<log id="8487">
<object>Agency</object>
<objectId>354</objectId>
<action>edit</action>
<timestamp>2014-02-07T10:42:40</timestamp>
<username>nowhere.man</username>
</log>
<log id="8488">
<object>PersonContact</object>
<objectId>1</objectId>
<action>update</action>
<timestamp>2014-02-07T10:43:13</timestamp>
<username>nowhere.man</username>
</log>
<log id="8489">
<object>Booking</object>
<objectId>245</objectId>
<action>update</action>
<timestamp>2014-02-07T10:43:26</timestamp>
<username>nowhere.man</username>
</log>
<log id="8490">
<object>SessionGroup</object>
<objectId>8</objectId>
<action>insert</action>
<timestamp>2014-02-07T10:43:29</timestamp>
<username>nowhere.man</username>
</log>
<log id="8492">
<object>Participant</object>
<objectId>25489</objectId>
<action>update</action>
<timestamp>2014-02-07T10:43:29</timestamp>
<username>al.mccaig.transit</username>
<relates>
<Session>606</Session>
<Person>1</Person>
</relates>
</log>
</changelog>

==Object Specific Calls==
If you are only interested to changes to a specific object, you can append the object name to the call:
curl --url <Base URL>/<objectType> -u<username>:<password> -H Content-Type:text/xml

* ''objectType'' - One for the following values
** AgencyProject
** Note
** Participant
** Person
** PersonContact
** Questionnaire
** Session
** SessionGroup
** ValueList

e.g. for sessions
curl --url <Base URL>/session -u<username>:<password> -H Content-Type:text/xml

==Restricting the changes by date==
By default the API will return up to the last 4000 changes logged. However, you can fetch specific date ranges using the <code>timestamp</code>, you can also use the ''-from'' and ''-to'' modifiers to specify a date range:
curl --url <Base URL>/<objectType>?timestamp-from=<date>&timestamp-to=<date> -u<username>:<password> -H Content-Type:text/xml

==An example use==

This is an example script to check for changes of 3 objectTypes that occurred during the previous day and will build a list of object URL's for objects ready for fetching.
<syntaxhighlight lang="php" >
<?php
print "Begin...\n";

// The API credentials
$username = 'YOUR USERNAME';
$password = 'YOUR PASSWORD';

// Uncomment the the relevant API URL
//$baseURL = 'http://dev.views.coop/api/restful/'; // Development Server
$baseURL = 'http://testing.views.coop/api/restful/'; // Live Server
//$baseURL = 'https://app.views.coop/api/restful/'; // Live Server

if (!ini_get('display_errors')) {
ini_set('display_errors', true);
}

function curl_download($Url, $params, $username, $password, $headers=''){

// is cURL installed yet?
if (!function_exists('curl_init')){
die('Sorry cURL is not installed!');
}

// OK cool - then let's create a new cURL resource handle
$ch = curl_init();

// Now set some options (most are optional)

$Url.='?'.http_build_query($params);

// Set URL to download
curl_setopt($ch, CURLOPT_URL, $Url);

// Set username and password
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);

// See if we pass any headers
if (is_array($headers) && sizeof($headers)) {
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
}

// User agent
curl_setopt($ch, CURLOPT_USERAGENT, "APIChangeLogProcessor/1.0");

// Include header in result? (0 = yes, 1 = no)
curl_setopt($ch, CURLOPT_HEADER, 0);

// Should cURL return or print out the data? (true = return, false = print)
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Timeout in seconds
curl_setopt($ch, CURLOPT_TIMEOUT, 30);

// Download the given URL, and return output
$output = curl_exec($ch);

// Close the cURL resource, and free system resources
curl_close($ch);

return $output;
}

$baseURL .= '/admin/changelog';

// Use the following to define the desired file format
// Please Note: The json format has not been fully tested with these scripts
//$contentType = 'text/xml';
$contentType = 'application/json';
//$extension = 'xml';
$extension = 'json';

// I would not recomend fetching more than a days worth of changelogs. If you want to fecth more, then loop through the days individually
$params['timestamp-from'] = date('Y-m-d', strtotime('yesterday')); // Could be a param and set to an exact time it last ran

// You can use the updated field for person records
$objects = array('agencyproject', 'participant','session','sessionGroup');

$recordsToFetch = array();

// Loop through each of the change log objects
foreach( $objects as $thisObject ) {

$response = json_decode(curl_download($baseURL.'/'.$thisObject, $params, $username, $password, array("Accept: {$contentType}")), true);;

while( ($thisRecord = array_shift($response) ) ) {

if (strtolower($thisRecord['object']) == 'participant') {
if (!$thisRecord['relates']['Session']) {
// There are a few cases where an extra log line is printed.
// We just need to skip these
continue;
}

$recordsToFetch[] = "/sessions/{$thisRecord['relates']['Session']}/participants";

} else {
$recordsToFetch[] = "/".strtolower($thisRecord['object'])."s/{$thisRecord['objectId']}";
}
}

$thisRecord = $response = null; // Clean up to keep memory in control

}
sort($recordsToFetch);

$recordsToFetch = array_unique($recordsToFetch); // Strip duplicates

/**
* $recordsToFetch should now contain a list of all the records you need to refresh
* Which while testing on your data, a day and a half is returning < 4000 records to fetch
*/
print_r($recordsToFetch);
?>
</syntaxhighlight>

Rest - Admin - ProgrammeFields

2016-02-26T13:10:44Z

Wikiadmin: /* Base URL */

==Purpose==

When interacting with Views accounts, it is sometimes necessary to identify a field that is derieved from a program, and implemented in all agencies within that program. For example a Disability field. This can be achieved via this API

===Base URL===
https://app.viewsapp.net/api/restful/admin/programmefields

==Identify a programme field==

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

This will return a list of programme fields for the given field, for the programmes that the agency is associated with in the following format:
<?xml version="1.0" encoding="utf-8"?>
<programmefields>
<programmefield progid="18" sourceid="21">
<id>51</id>
<SourceID>21</SourceID>
<fieldName>Disability_P_51</fieldName>
<fieldLoc>f</fieldLoc>
<fieldType>text</fieldType>
<inputType>select
</inputType>
<validation>
</validation>
<valueListID>140</valueListID>
<tagline></tagline>
<category>Demographic</category>
<displayName>Disability</displayName>
<flags>255</flags>
<enabled>1</enabled>
<value></value>
</programmefield>
<programmefield progid="19" sourceid="40">
<id>80</id>
<SourceID>40</SourceID>
<fieldName>Disability_P_80</fieldName>
<fieldLoc>f</fieldLoc>
<fieldType>text</fieldType>
<inputType>select</inputType>
<validation></validation>
<valueListID>154</valueListID>
<tagline></tagline>
<category>Demographic</category>
<displayName>Disability</displayName>
<flags>993</flags>
<enabled>1</enabled>
<value></value>
</programmefield>
</programmefields>

This shows there are 2 Disability fields, one for each Programme.

==Identify a programme field for a specific programme==

If you are only interested in knowing what a field is for a given programme, then you should use the following:
curl --url <Base URL>/<structure>/<fieldname>/<ProgID> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

Which will return:
<?xml version="1.0" encoding="utf-8"?>
<programmefields>
<programmefield progid="18" sourceid="21">
<id>51</id>
<SourceID>21</SourceID>
<fieldName>Disability_P_51</fieldName>
<fieldLoc>f</fieldLoc>
<fieldType>text</fieldType>
<inputType>select
</inputType>
<validation>
</validation>
<valueListID>140</valueListID>
<tagline></tagline>
<category>Demographic</category>
<displayName>Disability</displayName>
<flags>255</flags>
<enabled>1</enabled>
<value></value>
</programmefield>
</programmefields>

== Supported Structures ==
* Group
* Staff
* Volunteer
* Person
* SessionGroup
* Session
* Venue
* Field
* Media
* PersonContact
* CaseStudy

Rest - Admin - Outcomes

2016-02-26T13:10:19Z

Wikiadmin: /* Base URL */

==Purpose==

To fetch information about the outcomes an agency is associated with.
'''''Please note that this is currently a read only service'''''

===Base URL===
https://app.viewsapp.net/api/restful/admin/outcomes

==Retreive associated outcomes==

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

This will return a list of outcomes that the agency is associated with in the following format:
<?xml version="1.0" encoding="utf-8"?>
<admin>
<outcomes>
<outcome id="7">An Outcome</outcome>
<outcome id="18">Outcome 2</outcome>
<outcome id="19">Another Outcome</outcome>
</outcomes>
</admin>

Rest - Admin - Objectives

2016-02-26T13:10:03Z

Wikiadmin: /* Base URL */

==Purpose==

To fetch information about the objectives an agency is associated with.
'''''Please note that this is currently a read only service'''''

===Base URL===
https://app.viewsapp.net/api/restful/admin/objectives

==Retreive associated objectives==

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

This will return a list of objectives that the agency is associated with in the following format:
<?xml version="1.0" encoding="utf-8"?>
<admin>
<objectives>
<objective id="7">An Objective</objective>
<objective id="18">Objective 2</objective>
<objective id="19">Another Objective</objective>
</objectives>
</admin>

Rest - Admin - Programmes

2016-02-26T13:09:46Z

Wikiadmin: /* Purpose */

==Purpose==

To fetch information about the programmes an agency is associated with.

===Base URL===
https://app.viewsapp.net/api/restful/admin/programmes

==Retreive associated programmes==

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

This will return a list of programmes that the agency is associated with in the following format:
<?xml version="1.0" encoding="utf-8"?>
<admin>
<programmes>
<programme id="7">Football League Trust</programme>
<programme id="18">FLT + NCS Collaboration</programme>
<programme id="19">Sported Impact Analysis</programme>
<programme id="25">DFE YPFN</programme>
</programmes>
</admin>

==Fetching information about a programme==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
* '''id''' - The ID of the Value List

This will return an xml file similar to the following:
<?xml version="1.0" encoding="utf-8"?>
<programme id="7">
<ProgramID>7</ProgramID>
<Name>Football League Trust</Name>
<outcomeFrameworks>2|3|4</outcomeFrameworks>
<shortCode>FLT</shortCode>
</programme>

Rest - Admin - Value Lists

2016-02-26T13:09:29Z

Wikiadmin: /* Purpose */

==Purpose==

Used for maintaining the value lists within Views.

===Base URL===
https://app.viewsapp.net/api/restful/admin/valuelists

==Retrieve a list of available value lists==
curl --url <Base URL>?type=<type>&mode=<mode> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"

* type '''required''' - This must be one of the following values:
*# Staff
*# Volunteer
*# Individual
*# Person
*# Group
*# Session
*# SessionGroup
*# Question
*# Agency
*# Venue
*# QualificationProgress
*# QualificationAchievement
*# AddressBook
*# Report
* mode - this can be left blank to return a complete list, or one of the following values:
*# editable - filters the returned value lists that are allowed to be extended
*# nonsystem - filters the returned value lists to only Non System lists

==Retreive the details of a Value List==

curl --url <Base URL>/<id>/details -u<username>:<password> -H Content-Type:text/xml
* '''id''' - The ID of the Value List

This will return all the meta data about a Value list. '''''Needs more detail'''''

==Fetching a Value List==

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* '''id''' - The ID of the Value List

This will return an xml file similar to the following:
<?xml version="1.0" encoding="utf-8"?>
<valuelist id="42">
<items>
<item id="7">Red</item>
<item id="18">Green</item>
<item id="19">Blue</item>
<item id="25">Purple</item>
</items>
</valuelist>

==Fetching a Value List By Name==

curl --url <Base URL>/<type>/<name> -u<username>:<password> -H Content-Type:text/xml
* '''type''' - This is the type of the Value List. This must be one of the values stated above
* '''name''' - The name of the Value List

This will return an xml file in the same format as fetching a list by id

For eaxample, the following call will get a list of session group volunteering types:

curl --url <Base URL>/sessiongroup/volunteeringtypes -u<username>:<password> -H Content-Type:text/xml

Rest - Evidence - Questionnaires - Answers

2016-02-26T13:09:00Z

Wikiadmin: /* Schema */

==Purpose==

Used for submitting answer sets to questionnaires against participants and for retrieving the details of answered questionnaires that have been submitted. It is the preferred solution to use the contextualised version of this API.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/<qid>/answers</nowiki>
* qid - This is the questionnaire id

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/answers/answerset-schema(.xml|.json|.xsd)</nowiki>

<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/answers/answers-schema(.xml|.json|.xsd)</nowiki>

==Fetching a list of answer sets==
The default call will return a list of questionnaires (answer sets) that have been recorded against the questionnaire
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="2">
<answerset id="1" questionnaireid="14">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
<answerset id="6" questionnaireid="14">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<Date>2012-05-02T09:10:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>6</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
</answersets>

The results are order by the most recent first. This means to get the latest version of a questionnaire, you would only need to fetch the first result.

Optionally, you can can append the <code>?include-answers</code> parameter to include all the actual answer data alongside the answer set details. This will convert the <nowiki><answerset></nowiki> object to something more like that described below.
This is not recommended due to the volume of data that it could return

==Fetching the answers of a given questionnaire answerset==
curl --url <Base URL>/<setId> -u<username>:<password> -H Content-Type:text/xml
* setId - This is the id of the Answers Set you want to retrieve

It's will return something along the lines of
<answerset questionaireid="14" id="1">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<TargetType/>
<TargetID>0</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answers count="9">
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
<answer id="80">
<QuestionID>80</QuestionID>
<Answer>Agree</Answer>
</answer>
...
</answers>
</answerset>

==Fetching a single answer from a questionnaire==
curl --url <Base URL>/<setId>/<questionId> -u<username>:<password> -H Content-Type:text/xml
* setId - This is the id of the Answers Set you want to retrieve
* questionId - This is the id of the question you want the answer for

<answer id="78">
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>

==Creating a new Answer Set==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d '<xml>'

To submit a new set of answers against a questionnaire, you should send data in the following structure:

<answers>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
...
</answers>

'''Note:''' If you specify the attribute ''<code>id</code>'' then you do not need to specify the <code><QuestionID></code> entity.

You can also relate the questionnaire to a Session (and SessionGroup) by specifying the <code><TargetType></code> and <code><TargetID></code> entities

<answers>
<TargetType>Session</TargetType>
<TargetID>214</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
....
</answers>

You can also omit the <code><Date></code> entity. If you do this, then the current system date/time will be used.

==Updating an existing Answer Set==
curl --url <Base URL>/<setid> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

When updating the answers in an answer set, you should use the same structure as when creating a new answer set. However, if you specify the entities <code>TargetType></code> and <code>TargetID></code> they will be ignored.

Rest - Evidence - Questionnaires - Answers

2016-02-26T13:08:46Z

Wikiadmin: /* Purpose */

==Purpose==

Used for submitting answer sets to questionnaires against participants and for retrieving the details of answered questionnaires that have been submitted. It is the preferred solution to use the contextualised version of this API.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/<qid>/answers</nowiki>
* qid - This is the questionnaire id

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/answers/answerset-schema(.xml|.json|.xsd)</nowiki>
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/answers/answers-schema(.xml|.json|.xsd)</nowiki>

==Fetching a list of answer sets==
The default call will return a list of questionnaires (answer sets) that have been recorded against the questionnaire
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="2">
<answerset id="1" questionnaireid="14">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
<answerset id="6" questionnaireid="14">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<Date>2012-05-02T09:10:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>6</AnswerSetID>
<Questionnaire>Impact</Questionnaire>
</answerset>
</answersets>

The results are order by the most recent first. This means to get the latest version of a questionnaire, you would only need to fetch the first result.

Optionally, you can can append the <code>?include-answers</code> parameter to include all the actual answer data alongside the answer set details. This will convert the <nowiki><answerset></nowiki> object to something more like that described below.
This is not recommended due to the volume of data that it could return

==Fetching the answers of a given questionnaire answerset==
curl --url <Base URL>/<setId> -u<username>:<password> -H Content-Type:text/xml
* setId - This is the id of the Answers Set you want to retrieve

It's will return something along the lines of
<answerset questionaireid="14" id="1">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<TargetType/>
<TargetID>0</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answers count="9">
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
<answer id="80">
<QuestionID>80</QuestionID>
<Answer>Agree</Answer>
</answer>
...
</answers>
</answerset>

==Fetching a single answer from a questionnaire==
curl --url <Base URL>/<setId>/<questionId> -u<username>:<password> -H Content-Type:text/xml
* setId - This is the id of the Answers Set you want to retrieve
* questionId - This is the id of the question you want the answer for

<answer id="78">
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>

==Creating a new Answer Set==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d '<xml>'

To submit a new set of answers against a questionnaire, you should send data in the following structure:

<answers>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
...
</answers>

'''Note:''' If you specify the attribute ''<code>id</code>'' then you do not need to specify the <code><QuestionID></code> entity.

You can also relate the questionnaire to a Session (and SessionGroup) by specifying the <code><TargetType></code> and <code><TargetID></code> entities

<answers>
<TargetType>Session</TargetType>
<TargetID>214</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
....
</answers>

You can also omit the <code><Date></code> entity. If you do this, then the current system date/time will be used.

==Updating an existing Answer Set==
curl --url <Base URL>/<setid> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

When updating the answers in an answer set, you should use the same structure as when creating a new answer set. However, if you specify the entities <code>TargetType></code> and <code>TargetID></code> they will be ignored.

Rest - Evidence - Questionnaires - Questions

2016-02-26T13:08:16Z

Wikiadmin: /* Purpose */

==Purpose==

This API is used for creating, editing and deleting questionnaires from the Views system. It is '''not''' a way to submit questionnaire answer data. That is done via the other various sections.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/<id>/questions</nowiki>
* id - The is the id of the questionnaire.

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/evidence/questionnaires/questions/schema(.xml|.json|.xsd)</nowiki>

==Listing available Questions==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml
* query - This is a text string to use to search for in the venues records

Questions are not searchable, and by default ''only'' the enabled questions are returned. If you want to get a complete list of questions, then you should use the following:
curl --url <Base URL>?allquestions=1 -u<username>:<password> -H Content-Type:text/xml

<questions count="21">
<question id="12">
<QuestionID>12</QuestionID>
<QuestionnaireID>3</QuestionnaireID>
<Question>What?</Question>
<valueListID>83</valueListID>
<inputType>radio</inputType>
<validation></validation>
<category>What</category>
<enabled>1</enabled>
<order>0</order>
<Created>2011-03-04 01:09:55</Created>
<CreatedBy>ant</CreatedBy>
<Updated>2011-03-04 01:09:55</Updated>
<UpdatedBy>ant</UpdatedBy>
</question>
...
<question id="13">
<QuestionID>13</QuestionID>
<QuestionnaireID>3</QuestionnaireID>
<Question>Date</Question>
<valueListID>0</valueListID>
<inputType>date</inputType>
<validation>valid_date</validation>
<category>What</category>
<enabled>1</enabled>
<order>0</order>
<Created>2011-03-04 01:10:09</Created>
<CreatedBy>ant</CreatedBy>
<Updated>2011-03-04 01:10:09</Updated>
<UpdatedBy>ant</UpdatedBy>
</question>
</questions>

==Fetching a Question's details==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
* id - The id of the Question

This will return a single question in the format of:
<question id="12">
<QuestionID>12</QuestionID>
<QuestionnaireID>3</QuestionnaireID>
<Question>What is the question</Question>
<valueListID>83</valueListID>
<inputType>radio</inputType>
<validation></validation>
<category>What</category>
<enabled>1</enabled>
<Created>2011-03-04 01:09:55</Created>
<CreatedBy>ant</CreatedBy>
<Updated>2011-03-04 01:09:55</Updated>
<UpdatedBy>ant</UpdatedBy>
</question>

==Creating a Single Question==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d '<xml>'

<code><xml></code> should be in the following format:
<question>
<Question>The question test...</Question>
<inputType>text</inputType>
<valueListID>0</valueListID>
<validation/>
<category>General</category>
</question>

* Question - This should contain the wording for the question
* inputTypes - This can be ne of the following:
*# text
*# textare
*# date
*# time
*# number
*# select
*# selectother
*# checkselect
*# radio
* valueListID - refers to a [[Rest - Admin - Value Lists|value list]]. This is only used with multiple choice inputTypes
* category - This is the section title that the question should be grouped in

===Validation Field===
This can contain values similar to those found in the validation field for structure objects. However, here is a more specific explanation of the various optionsyou can place into this field:

* '''oneOf''' - One of the questions are required to be answered.
* '''required_if''' - The answer is required if condition met.
* '''required''' - The answer is required.
* '''valid_password''' - The answer field must contain a valid password as defined above
* '''valid_postcode''' - The answer field must contain a valid postcode.
* '''valid_email''' - The answer must contain a valid email address.
* '''valid_emails''' - The answer must contain all valid email addresses.
* '''valid_url''' - The answer must contain a valid URL.
* '''real_url''' - The answer must contain a real URL.
* '''valid_ip''' - The answer must contain a valid IP.
* '''valid_date''' - The answer must contain a valid date.
* '''min_length[n]''' - The answer must be at least ''n'' characters in length.
* '''max_length[n]''' - The answer can not exceed ''n'' characters in length.
* '''exact_length[n]''' - The answer must be exactly ''n'' characters in length.
* '''alpha''' - The answer may only contain alphabetical characters.
* '''alpha_numeric''' - The answer may only contain alpha-numeric characters.
* '''alpha_dash''' - The answer may only contain alpha-numeric characters, underscores, and dashes.
* '''alpha_dot''' - The answer field may only contain alpha-numeric characters, and dots.
* '''numeric''' - The answer must contain only numbers.
* '''is_numeric''' - The answer must contain only numeric characters.
* '''is_numeric_non_zero''' - The answer must contain only numeric characters greater than zero.
* '''integer''' - The answer must contain an integer.
* '''is_natural''' - The answer must contain only positive numbers.
* '''is_natural_no_zero''' - The answer must contain a number greater than zero.
* '''range[min,max]''' - The answer is not within range.
* '''unique_username''' - The answer value is already assigned, please try another
* '''punique''' - The answer value already exists, within The, or another agency with the Programme

'''''Note''' The following require further documentation (currently the wording isfor the error''
* '''matches''' - The answer does not match any other Answer.
* '''nomatches''' - The answer matches the other answers.
* '''matches1M''' - The answer value matches none of the other answer values.
* '''nomatches1M''' - The answer value matches one of the other answer values.
* '''matchesM1''' - None of the answer values match this answer value.
* '''nomatchesM1''' - One of the answer values matches this answer field.
* '''matchesMM''' - None of the answer values match any of this answer values.
* '''nomatchesMM''' - Some of the answer values match some of this answer values.

==Updating a Single Question==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'
* id - The id of the question

The xml for updating a single question is exactly the same as the create xml.

==Disable / Enable Questions==
curl --url <Base URL>/<id>/enable -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'
* id - The id of the question

To disable a question you need to send the following xml:
<enable>0</enable>
''or''
<enable>false</enable>

To enable a question you need to send the following xml:
<enable>1</enable>
''or''
<enable>true</enable>

==Creating / Updating Multiple Question==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X [POST|PUT] -d '<xml>'
* id - The id of a Questionnaire

This allows you to upload a complete questionnaire in one go

<questions>
<question id="12">
<Question>Update question 12</Question>
<valueListID>83</valueListID>
<inputType>radio</inputType>
<validation></validation>
<category>What</category>
</question>
...
<question>
<Question>Add a new question</Question>
<inputType>text</inputType>
<valueListID>0</valueListID>
<validation/>
<category>General</category>
</question>
</questions>

By specifying the id attribute for the question, it will update the question rather than create a new one.

It is recommended that you stip to using the PUT method for this, as in the future we make make POST and method to replace all the questions on a questionnaire

Rest - Evidence - Questionnaires

2016-02-26T13:07:57Z

Wikiadmin:

Rest - Work - Agency Projects - Outcomes

2016-02-26T13:07:35Z

Wikiadmin:

==Purpose==

Used for administering the association of outcomes with agency projects in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/agencyprojects/id/outcomes</nowiki>
* '''id''' - This is the id of the agency project

'''Note:''' If the Agency Project has been archived, this API becomes read only.''

===Getting the list of outcomes===
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of outcomes that are associated with the agency project.
<?xml version="1.0" encoding="utf-8"?>
<agencyproject id="1">
<outcomes>
<outcome id="2">Outcome Hits Sported</outcome>
<outcome id="5">Outcome that hist sported not obesity</outcome>
</outcomes>
</agencyproject>

===Adding outcomes to an Agency Project===
You can add a single outcome via the following:
curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X PUT
*'''sid''' - The ID of the outcome to add

You can also upload a a list of outcomes to add to the agency project via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<outcomes>
<outcome>1</outcome>
<outcome>2</outcome>
<outcome>3</outcome>
</outcomes>

Used for administering participant registrations on outcomes in the Views system.

===Removing an outcome from an Agency Project===
You can remove a single outcome from an agency project via the following:
curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''sid''' - The ID of the outcome to add

You can also upload a a list of outcomes to remove from the agency project via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<outcomes>
<outcome>1</outcome>
<outcome>2</outcome>
<outcome>3</outcome>
</outcomes>

Rest - Work - Agency Projects - Objectives

2016-02-26T13:07:16Z

Wikiadmin: /* Purpose */

==Purpose==

Used for administering the association of objectives with agency projects in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/agencyprojects/id/objectives</nowiki>
* '''id''' - This is the id of the agency project

'''Note:''' If the Agency Project has been archived, this API becomes read only.''

===Getting the list of objectives===
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of objectives that are associated with the agency project.
<?xml version="1.0" encoding="utf-8"?>
<agencyproject id="1">
<objectives>
<objective id="2">Objective Hits Sported</objective>
<objective id="5">Objective that hist sported not obesity</objective>
</objectives>
</agencyproject>

===Adding objectives to an Agency Project===
You can add a single objective via the following:
curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X PUT
*'''sid''' - The ID of the objective to add

You can also upload a a list of objectives to add to the agency project via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<objectives>
<objective>1</objective>
<objective>2</objective>
<objective>3</objective>
</objectives>

Used for administering participant registrations on objectives in the Views system.

===Removing an objective from an Agency Project===
You can remove a single objective from an agency project via the following:
curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''sid''' - The ID of the objective to add

You can also upload a a list of objectives to remove from the agency project via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<objectives>
<objective>1</objective>
<objective>2</objective>
<objective>3</objective>
</objectives>

Rest - Work - Agency Projects - Session Groups

2016-02-26T13:06:57Z

Wikiadmin:

==Purpose==

Used for administering the association of session groups with agency projects in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/agencyprojects/id/sessiongroups</nowiki>
* '''id''' - This is the id of the agency project

'''Note:''' If the Agency Project has been archived, this API becomes read only.''

===Getting the list of session groups===
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of session groups that are associated with the agency project.

===Adding session groups to an Agency Project===
You can add a single session group via the following:
curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X PUT
*'''sid''' - The ID of the session group to add

You can also upload a a list of session groups to add to the agency project via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<sessiongroups>
<sessiongroup>1</sessiongroup>
<sessiongroup>2</sessiongroup>
<sessiongroup>3</sessiongroup>
</sessiongroups>

Used for administering participant registrations on session groups in the Views system.

===Removing a session group from an Agency Project===
You can remove a single session group from an agency project via the following:
curl --url <Base URL>/<sid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''sid''' - The ID of the session group to add

You can also upload a a list of session groups to remove from the agency project via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<sessiongroups>
<sessiongroup>1</sessiongroup>
<sessiongroup>2</sessiongroup>
<sessiongroup>3</sessiongroup>
</sessiongroups>

Rest - Work - Agency Projects

2016-02-26T13:06:42Z

Wikiadmin: /* Purpose */

==Purpose==

Used for creating, editing and deleting Agency Projects from the Views system.

===Base URL===
https://app.viewsapp.net/api/restful/work/agencyprojects

===Schema===
<nowiki>https://app.viewsapp.net/api/restful/work/agencyprojects/schema(.xml|.json|.xsd)</nowiki>

==Creating Agency Projects==

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 an Agency Project==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml

==Searching for Agency Projects==
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 agency project 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:
* Created - yyyy-mm-dd
* Updated - yyyy-mm-dd
* Archived - yyyy-mm-dd

==Updating an Agency Project==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X PUT -d "<xml>"
* id - The ID of the agency project

The XML should be in the same format as the create XML.

==Archiving an Agency Project==
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 agency project

This will set the archive flag on an Agency project. If you set the status to 0, then it will remove the archive flag.

==Deleting an Agency Project==
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X DELETE
* id - The ID of the agencyprojects

This should be used with great care as it will permenently delete an Agency Projects record.

Rest - Work - Session Groups - Session Questionnaires

2016-02-26T13:06:23Z

Wikiadmin:

==Purpose==

Used for submitting answer sets to questionnaires against sessions and for retrieving the details of answered questionnaires that have been submitted against a participant. This is only really a filtered version of the [[Rest - Evidence - Questionnaires - Answers|Questionnaires - Answers API]]

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<id>/questionnaires</nowiki>
* id - This is the session id

===Schema===
For details of the schemas, please refer to [[Rest - Evidence - Questionnaires - Answers]]

==Fetching a list of answer sets==
The default call will return a list of questionnaires (answer sets) that have been recorded against the participant
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="3">
<answerset id="13" questionnaireid="3">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<TargetType>Session</TargetType>
<TargetID>68</TargetID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Session Attendance Questionnaire</Questionnaire>
</answerset>
<answerset id="14" questionnaireid="4">
<EntityType>Session</EntityType>
<EntityID>68</EntityID>
<TargetType>Session</TargetType>
<TargetID>68</TargetID>
<Date>2012-05-04T10:11:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>4</AnswerSetID>
<Questionnaire>Questionnaire about the session</Questionnaire>
</answerset>
...
</answersets>

If you are only interested in a particular questionnaire, you should us the following:
curl --url <Base URL>/<questionnairId> -u<username>:<password> -H Content-Type:text/xml

This will return data similar to the following:
<answersets count="1">
<answerset id="13" questionnaireid="3">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<TargetType>Session</TargetType>
<TargetID>68</TargetID>
<Date>2012-07-31T10:00:00</Date>
<QuestionnaireID>14</QuestionnaireID>
<AnswerSetID>1</AnswerSetID>
<Questionnaire>Session Attendance Questionnaire</Questionnaire>
</answerset>
</answersets>

The results are order by the most recent first. This means to get the latest version of a questionnaire, you would only need to fetch the first result.

==Fetching the answers of a given questionnaire==
curl --url <Base URL>/<questionnairId>/<setId> -u<username>:<password> -H Content-Type:text/xml
* questionnaireId - This is the id of the questionnaire
* setId - This is the id of the Answers Set you want to retrieve

It's will return something along the lines of
<answerset questionaireid="3" id="13">
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<TargetType>Session</TargetType>
<TargetID>68</TargetID>
<Date>2012-07-31T10:00:00</Date>
<answers count="5">
<answer id="23">
<QuestionID>25</QuestionID>
<Answer>On time</Answer>
</answer>
<answer id="24">
<QuestionID>25</QuestionID>
<Answer>Tidy</Answer>
</answer>
<answer id="25">
<QuestionID>25</QuestionID>
<Answer>Yes</Answer>
</answer>
...
</answers>
</answerset>

==Fetching a single answer from a questionnaire==
curl --url <Base URL>/<questionnairId>/<setId>/<questionId> -u<username>:<password> -H Content-Type:text/xml
* questionnaireId - This is the id of the questionnaire
* setId - This is the id of the Answers Set you want to retrieve
* questionId - This is the id of the question you want the answer for

<answer id="78">
<QuestionnaireID>3</QuestionnaireID>
<AnswerSetID>13</AnswerSetID>
<QuestionID>25</QuestionID>
<Answer>Yes</Answer>
</answer>

==Creating a new Answer Set==
curl --url <Base URL>/<questionnairId> -u<username>:<password> -H Content-Type:text/xml -X POST -d '<xml>'

To submit a new set of answers against a questionnaire, you should send data in the following structure:

<answers>
<EntityType>Person</EntityType>
<EntityID>1</EntityID>
<Date>2012-07-31T10:00:00</Date>
<answer id="78">
<QuestionID>78</QuestionID>
<Answer>Fully Agree</Answer>
</answer>
<answer id="79">
<QuestionID>79</QuestionID>
<Answer>Truly Agree</Answer>
</answer>
...
</answers>

'''Note:''' If you specify the attribute ''<code>id</code>'' then you do not need to specify the <code><QuestionID></code> entity.

If you omit the entities <code><EntityType></code> and <code><EntityID></code>, then the answer set is related to the Session it's self. Currently, this is ''not'' supported via the UI.

You can also omit the <code><Date></code> entity. If you do this, then the current system date/time will be used.

==Updating an existing Answer Set==
curl --url <Base URL>/<questionnairId>/<setid> -u<username>:<password> -H Content-Type:text/xml -X PUT -d '<xml>'

When updating the answers in an answer set, you should use the same structure as when creating a new answer set. However, if you specify the entities <code><EntityType></code>, <code><EntityID></code>, <code>TargetType></code>, <code>TargetID></code> they will be ignored.

Rest - Work - Session Groups - Session Staff

2016-02-26T13:06:04Z

Wikiadmin: /* Purpose */

==Purpose==

Used for administering participation by staff at sessions in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<sid>/staff</nowiki>
* '''sid''' - This is the id of the session group

==Getting the list of staff==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of staff that are associated with a session, similar to the following:
<session id="7">
<staff>
<staff id="123">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<ContactType>Staff</ContactType>
<ContactID>123</ContactID>
<Name>Jane Smith</Name>
<Role>Lead</Role>
<Attended>0</Attended>
<Volunteering></Volunteering>
</staff>
<staff id="102">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<ContactType>Staff</ContactType>
<ContactID>102</ContactID>
<Name>John Smith</Name>
<Role>Assistant</Role>
<Attended>1</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</staff>
<staff>
</sessiongroup>

==Adding Staff to a session==
===Adding a single staff to a session===
You can add a single staff record via the following:
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<staff>
<ContactID>101457</ContactID>
<Attended>0</Attended>
<Role>Assistant</Role>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</staff>

* Attended is either 1 or 0, 1 = Attended. This is optional and will default to 0, unless the session has started, in which case the default is 1.
* Role - This is optional, but can contain a value of Lead or Assistant
* Volunteering - Values should be pipe(|) delimited. This is optional, but will clear volunteering for the member of staff for that session.

===Adding multiple staff to a session===
You can also upload a a list of staff to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

This can be useful for setting a register of attending staff.

<staff>
<staff>
<ContactID>101457</ContactID>
<Attended>0</Attended>
<Role>Lead</Role>
</staff>
<staff>
<ContactID>457</ContactID>
<Attended>1</Attended>
<Role>Assistant</Role>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</staff>
<staff>
<ContactID>57</ContactID>
<Attended>1</Attended>
<Role></Role>
<Volunteering>Cleaned up</Volunteering>
</staff>
</staff>

'''''Please note:''' This will replace all existing participant data for the session''

==Removing staff from a session==
You can remove a single staff record from a session via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the staff to add

You can also upload a a list of staff to remove from the session via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<staff>
<staff>101162</staff>
<staff>103124</staff>
<staff>103413</staff>
</staff>

Rest - Work - Session Groups - Session Participants

2016-02-26T13:05:46Z

Wikiadmin: /* Purpose */

==Purpose==

Used for administering participation by participants at sessions in the Views system.

===Base URL===
<nowiki>https://app.viewsapp.net/api/restful/work/sessiongroups/sessions/<sid>/participants</nowiki>
* '''sid''' - This is the id of the session group

==Getting the list of participants==
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml

This will return a list of participants that are associated with a session, similar to the following:
<session id="7">
<participants>
<participant id="123">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<Name>Jane Smith</Name>
<ContactType>Individual</ContactType>
<Attended>0</Attended>
<Volunteering></Volunteering>
</participant>
<participant id="102">
<SessionID>25</SessionID>
<SessionGroupID>7</SessionGroupID>
<Name>John Smith</Name>
<ContactType>Individual</ContactType>
<Attended>1</Attended>
<Volunteering>Made Coffee</Volunteering>
</participant>
<participants>
</sessiongroup>

==Adding Participants to a session==

===Adding participants to a bookable session===
Due to financial information being required for bookable sessions, the method of adding participants in slightly different.

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

<participant>
<PersonID>100748</PersonID>
<PaymentType>Debit Card</PaymentType>
<PaymentAmount>20</PaymentAmount>
<PaymentFee>2.50</PaymentFee>
<PaymentReference>7002</PaymentReference>
<Forename>Father</Forename>
<Surname>Test</Surname>
<Address1/>
<Address2/>
<Town/>
<County/>
<Postcode/>
<Telephone/>
<Email>test@test.com</Email>
</participant>

This will return errors on a fail or the full booking record on a successful submit.

The required fields are all required:
* PersonID - This is the ID of the participant
* PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
* PaymentAmount - This is the amount paid

===Adding a single participant to a session===
You can add a single participant via the following:
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

<participant>
<ContactID>101457</ContactID>
<Attended>0</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</participant>

The value for Attended is either 1 or 0, 1 = Attended. This is optional and will default to 0, unless the session has started, in which case the default is 1.

===Adding multiple participants to a session===
You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT

This can be useful for setting a register of attending participants.

<participants>
<participant>
<ContactID>101457</ContactID>
<Attended>0</Attended>
</participant>
<participant>
<ContactID>457</ContactID>
<Attended>1</Attended>
<Volunteering>Volunteered|Made Coffee</Volunteering>
</participant>
<participant>
<ContactID>57</ContactID>
<Attended>1</Attended>
<Volunteering>Cleaned Up</Volunteering>
</participant>
</participants>

'''''Please note:''' This will replace all existing participant data for the session''

==Removing participants from a session==

===Removing participants from a non bookable session group===

You can remove a single participant from a session via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to add

You can also upload a a list of participants to remove from the session via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE

<participants>
<participant>101162</participant>
<participant>103124</participant>
<participant>103413</participant>
</participants>

===Removing participants from a bookable session===
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
*'''pid''' - The ID of the participant to remove

By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:

<refundtype>Refund</refundtype>

or

<refundtype>Credit</refundtype>

This will result in the participants booking being completely being removed from the session