Skip to content

Developers

How can we help you?

← Go back

Mapping entry

The mapping entry is used to associate a enumeration entry with a mapping

A mapping entry looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<mapping-entry>
  <id type="integer">34</id>
  <value>Bouygues</value>
  <link rel="entry" href="https://movida.bebanjo.net/api/entries/66475"/>
  <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/7"/>
</mapping-entry>

{
  "resource_type": "mapping_entry",
  "id": 34,
  "value": "Bouygues",
  "entry_link": "https://movida.bebanjo.net/api/entries/66475",
  "mapping_link": "https://movida.bebanjo.net/api/mappings/7"
}

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

Valid attributes

  • name (required): string used internally to identify that entry.
  • entry (optional): The enumeration entry it belongs to.
  • mapping (optional): The mapping it belongs to.

Get a list of all mapping entries for an enumeration entry

Mapping entries are accessed via the Enumeration entry they belong to, as in the example below, through the link identified by the mapping_entries link:

<?xml version='1.0' encoding='utf-8' ?>
<entries type="array">
  <entry>
    <id type="integer">66475</id>
    <value>France &gt; Bouygues &gt; Boing &gt; Catch Up</value>
    <description>France &gt; Bouygues &gt; Boing &gt; Catch Up</description>
    <link rel="self" href="https://movida.bebanjo.net/api/entries/66475"/>
    <link rel="enumeration" href="https://movida.bebanjo.net/api/enumerations/879"/>
    <link rel="mapping_entries" href="https://movida.bebanjo.net/api/entries/66475/mapping_entries"/>
  </entry>
</entries>

{
  "entries": [
    {
      "resource_type": "entry",
      "id": 66475,
      "value": "France > Bouygues > Boing > Catch Up",
      "description": "France > Bouygues > Boing > Catch Up",
      "self_link": "https://movida.bebanjo.net/api/entries/66475",
      "enumeration_link": "https://movida.bebanjo.net/api/enumerations/879",
      "mapping_entries_link": "https://movida.bebanjo.net/api/entries/66475/mapping_entries"
    }
  ]
}

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

$ curl --digest -u robot_user:password https://movida.bebanjo.net/api/entries/66475/mapping_entries

$ curl --digest -u robot_user:password -H "Accept: application/json" https://movida.bebanjo.net/api/entries/66475/mapping_entries

<?xml version="1.0" encoding="UTF-8"?>
<mapping-entries type="array">
  <mapping-entry>
    <id type="integer">34</id>
    <value>Bouygues</value>
    <link rel="entry" href="https://movida.bebanjo.net/api/entries/66475"/>
    <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/7"/>
  </mapping-entry>
  <mapping-entry>
    <id type="integer">35</id>
    <value>Boing</value>
    <link rel="entry" href="https://movida.bebanjo.net/api/entries/66475"/>
    <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/8"/>
  </mapping-entry>
  <mapping-entry>
    <id type="integer">36</id>
    <value>Catch Up</value>
    <link rel="entry" href="https://movida.bebanjo.net/api/entries/66475"/>
    <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/9"/>
  </mapping-entry>
  <mapping-entry>
    <id type="integer">1717</id>
    <value nil="true"/>
    <link rel="entry" href="https://movida.bebanjo.net/api/entries/66475"/>
    <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/24"/>
  </mapping-entry>
</mapping-entries>

{
  "entries": [
    {
      "resource_type": "mapping_entry",
      "id": 34,
      "value": "Bouygues",
      "entry_link": "https://movida.bebanjo.net/api/entries/66475",
      "mapping_link": "https://movida.bebanjo.net/api/mappings/7"
    },
    {
      "resource_type": "mapping_entry",
      "id": 35,
      "value": "Boing",
      "entry_link": "https://movida.bebanjo.net/api/entries/66475",
      "mapping_link": "https://movida.bebanjo.net/api/mappings/8"
    },
    {
      "resource_type": "mapping_entry",
      "id": 36,
      "value": "Catch Up",
      "entry_link": "https://movida.bebanjo.net/api/entries/66475",
      "mapping_link": "https://movida.bebanjo.net/api/mappings/9"
    },
    {
      "resource_type": "mapping_entry",
      "id": 1717,
      "value": "",
      "entry_link": "https://movida.bebanjo.net/api/entries/66475",
      "mapping_link": "https://movida.bebanjo.net/api/mappings/24"
    }
  ]
}

Creating a new mapping entry

To create mapping entries, you just need to POST proper XML/JSON mapping entry representation to the mapping entries URL of an enumeration entry.

For example, this POST would create a new mapping entry (we will use curl’s @ option, which reads data to be posted from a file):

$ cat mapping_entry.xml

$ cat mapping_entry.json

<mapping-entry>
  <value>Non-Linear</value>
  <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/9"/>
</mapping-entry>

{
    "resource_type": "mapping_entry",
    "value": "Non-Linear",
    "mapping_link": "https://movida.bebanjo.net/api/mappings/9"
}

$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -H "Accept: application/xml" -X POST -d @entry.xml "https://movida.bebanjo.net/api/entries/66475/mapping_entries"

$ curl --digest -u robot_user:password -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d @entry.json "https://movida.bebanjo.net/api/entries/66475/mapping_entries"

$ curl --digest -u robot_user:password -H "Content-Type: application/xml" -H "Accept: application/xml" -X POST -d @entry.xml "https://movida.bebanjo.net/api/entries/66475/mapping_entries"

$ curl --digest -u robot_user:password -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d @entry.json "https://movida.bebanjo.net/api/entries/66475/mapping_entries"

Mediagenix On-Demand will return the full XML/JSON of the mapping entry just created:

<?xml version="1.0" encoding="UTF-8"?>
<mapping-entry>
  <id type="integer">37</id>
  <value>Non-Linear</value>
  <link rel="self" href="https://movida.bebanjo.net/api/entries/66475/mapping_entries/37"/>
  <link rel="entry" href="https://movida.bebanjo.net/api/entries/66475"/>
  <link rel="mapping" href="https://movida.bebanjo.net/api/mappings/9"/>
</mapping-entry>

{
  "resource_type": "mapping_entry",
  "id": 37,
  "value": "Non-Linear",
  "entry_link": "https://movida.bebanjo.net/api/entries/66475",
  "mapping_link": "https://movida.bebanjo.net/api/mappings/9"
}