Rest - Contacts - Volunteers - Volunteering: Difference between revisions

From Views API Documentation
Jump to navigation Jump to search
(Created page with "==Purpose== This is a read only service. It is a search API to return sessions that the volunteer's record is associated with and have been volunteering at ===Base URL=== <n...")
 
 
Line 4: Line 4:


===Base URL===
===Base URL===
<nowiki>http://app.views.coop/api/restful/contacts/volunteers/<id>/volunteering</nowiki>
<nowiki>https://app.viewsapp.net/api/restful/contacts/volunteers/<id>/volunteering</nowiki>


==Usage==
==Usage==

Latest revision as of 13:03, 26 February 2016

Purpose

This is a read only service. It is a search API to return sessions that the volunteer's record is associated with and have been volunteering at

Base URL

https://app.viewsapp.net/api/restful/contacts/volunteers/<id>/volunteering

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 the volunteers record 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