Rest - Contacts - Participants - Sessions: Difference between revisions

From Views API Documentation
Jump to navigation Jump to search
Line 7: Line 7:


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


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

Revision as of 08:41, 21 June 2012

Purpose

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

Base URL

http://app.views.coop/api/restful/contacts/participants/<id>/sessions

Usage

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

Calling the Base URL without any parameters will return all Sessions that a participant is asociated 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