Namespaces & Extensions

Adding other information

There will be situations where reporting organisations want to publish additional data that are not covered by the default IATI elements, or want to specify the data using the original formats or values to avoid information loss. IATI provides two mechanisms for doing so:

  • Use an XML namespace to extend the schema.

  • Use the legacy-data element to provide original data values.

XML namespaces

The first approach allows reporting organisations to invent any required markup and add it to an IATI activity report. IATI users who don’t recognise the extended markup are required simply to ignore it, without reporting an error. Here is an example:

<iati-activity xmlns:acme="http://example.org/acme/ns#">

...

  <acme:risk-level>3</acme:risk-level>

...

</iati-activity>

In this example, ACME has defined its own namespace using the URL http://example.org/acme/ns# and mapped that to the prefix acme. It then adds the new element, acme:risk-level, to provide information about its risk assessment for the activity. IATI users who don’t recognise the http://example.org/acme/ns# namespace are required to ignore the acme:risk element rather than reporting an error, so the extended markup does not harm compatibility. Users who are familiar with the namespace, however, can take advantage of the additional information.

Adding XML namespaces in versions 2.0x

Please note: elements must occur in the order they are specified in the Schema. When adding XML namespaces in versions 2.0x of the IATI standard, they should be placed as the last element. At the activity level, they must only be included at the end of the activity (before </iati-activity>). If added as a subelement, the namespace element must be placed as the last subelement. Example:

  1. XML namespace at activity level

<iati-activity xmlns:acme="http://example.org/acme/ns#">

...

  </fss>
  <acme:risk-level>3</acme:risk-level>

...

</iati-activity>

  1. XML namespace as a subelement within transaction

<iati-activity xmlns:acme="http://example.org/acme/ns#">

...

  <transaction>

...

    </value>
    <acme:risk-level>3</acme:risk-level>
  </transaction>

...

</iati-activity>