Rest - Evidence - Questionnaires: Difference between revisions

From Views API Documentation
Jump to navigation Jump to search
mNo edit summary
Line 2: Line 2:


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.
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===
===Base URL===
Line 9: Line 8:
===Schema===
===Schema===
<nowiki>http://app.views.coop/api/restful/evidence/questionnaires/schema(.xml|.json|.xsd)</nowiki>
<nowiki>http://app.views.coop/api/restful/evidence/questionnaires/schema(.xml|.json|.xsd)</nowiki>


==Searching for available Questionnaires==
==Searching for available Questionnaires==

Revision as of 08:28, 18 July 2012

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

http://app.views.coop/api/restful/evidence/questionnaires

Schema

http://app.views.coop/api/restful/evidence/questionnaires/schema(.xml|.json|.xsd)

Searching for available Questionnaires

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


Fetching a Questionnaire's details

curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml
  • id - The id of the Questionnaire

This will also return all enabled questions for the specified questionnaire.