Rest - Admin - Value Lists

Purpose

Used for maintaining the value lists within Views.

Base URL

https://app.viewsapp.net/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:
  1. Staff
  2. Volunteer
  3. Individual
  4. Person
  5. Group
  6. Session
  7. SessionGroup
  8. Question
  9. Agency
  10. Venue
  11. QualificationProgress
  12. QualificationAchievement
  13. AddressBook
  14. Report
• mode - this can be left blank to return a complete list, or one of the following values:
  1. editable - filters the returned value lists that are allowed to be extended
  2. 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

• 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

• 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" count="4" archived-items="2">
    <items>
        <item id="7">Red</item>
        <item id="18">Green</item>
        <item id="19">Blue</item>
        <item id="25">Purple</item>
    </items>
</valuelist>

Returning Archived Values

If an additional parameter include-archived=1 is passed then the following would be output:

<?xml version="1.0" encoding="utf-8"?>
<valuelist id="42" count="6" archived-items="2">
    <items>
        <item id="7">Red</item>
        <item id="18">Green</item>
        <item id="19">Blue</item>
        <item id="25">Purple</item>
        <item id="26" archived="true">Orange</item>
        <item id="27" archived="true">White</item>
    </items>
</valuelist>

Fetching a Value List By Name

curl --url <Base URL>/<type>/<name> -u<username>:<password> -H Content-Type:text/xml

• type - This is the type of the Value List. This must be one of the values stated above
• name - The name of the Value List

This will return an xml file in the same format as fetching a list by id

For eaxample, the following call will get a list of session group volunteering types:

curl --url <Base URL>/sessiongroup/volunteeringtypes -u<username>:<password> -H Content-Type:text/xml