Rest - Admin - Value Lists: Difference between revisions
Jump to navigation
Jump to search
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 | ||
==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 | |||
Revision as of 09:28, 17 July 2012
Purpose
Used for maintaining the value lists within Views.
Base URL
http://app.views.coop/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 -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"> <items> <item id="7">Red</item> <item id="18">Green</item> <item id="19">Blue</item> <item id="25">Purple</item> </items> </valuelist>