We use cookies (just for analytics) on this website. If you continue we will assume you are happy with it. ok

BeBanjo

Back to index

Enumeration entry

The Enumeration entry is used to populate the list of elements of an enumeration

A enumeration entry looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<entry>
  <id type="integer">135</id>
  <value>stereo</value>
  <description>Stereo</description>
</entry>

Note: currently enumerations cannot be created/updated/destroyed through the API. Please, contact your Technical Account Manager in order to define the list of enumerations suitable for your company.

Valid attributes

  • value (required): string used internally to identify that entry.
  • description (required): string used on the Movida UI to represent the entry.

Get a list of all entries for an enumeration

Entries are accessed via the Enumeration they belong to, as in the example below, through the link identified by the rel="entries" attribute:

<?xml version='1.0' encoding='utf-8' ?>
<enumerations type="array">
  <enumeration>
    <id type="integer">135</id>
    <name>Audio Mix Type</name>
    <link rel="self" href="http://www.example.com/api/enumerations/135"/>
    <link rel="entries" href="http://www.example.com/api/enumerations/135/entries"/>
  </enumeration>
</enumerations>

If we follow that link, we can fetch the list of all entries for that enumeration.

$ curl --digest -u robot_user:password http://www.example.com/api/enumerations/135/entries
<?xml version="1.0" encoding="UTF-8"?>
<entries type="array">
  <entry>
    <id type="integer">314</id>
    <value>Mono</value>
    <description>mono</description>
  </entry>
  <entry>
    <id type="integer">315</id>
    <value>Stereo</value>
    <description>stereo</description>
  </entry>
</entries>

Last updated November 19th, 2019.