Rest - Admin - Value Lists: Difference between revisions

From Views API Documentation
Jump to navigation Jump to search
(Created page with "==Purpose== Used for maintaining the value lists within Views. ===Base URL=== http://app.views.coop/api/restful/admin/valuelists ==Fetching a Value List== curl --url <Bas...")
 
No edit summary
Line 5: Line 5:
===Base URL===
===Base URL===
http://app.views.coop/api/restful/admin/valuelists
http://app.views.coop/api/restful/admin/valuelists
==Retreive the details of a Value List==
curl --url <Base URL>/<id>/details -u<username>:<password> -H Content-Type:text/xml -X POST -d "<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==
==Fetching a Value List==

Revision as of 11:18, 18 April 2012

Purpose

Used for maintaining the value lists within Views.

Base URL

http://app.views.coop/api/restful/admin/valuelists


Retreive the details of a Value List

curl --url <Base URL>/<id>/details -u<username>:<password> -H Content-Type:text/xml -X POST -d "<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 -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"?>
<valuelist id="42">
    <item id="7">Red</item>
    <item id="18">Green</item>
    <item id="19">Blue</item>
    <item id="25">Purple</item>
</valuelist>