recipient-region¶
iati-organisations/iati-organisation/recipient-region-budget/recipient-region
This is the reference page for the XML element recipient-region.
Definition¶
The supranational geographic region where funds have been allocated.
Rules¶
This element must occur once and only once (within each parent element).
Attributes¶
- @vocabulary
An IATI code for the vocabulary from which the region code is drawn. If it is not present, code 1 (‘OECD DAC’) is assumed.
This value must be of type xsd:string.
This value must be on the RegionVocabulary codelist.
- @vocabulary-uri
The URI where this vocabulary is defined. If the vocabulary is 99 (reporting organisation), the URI where this internal vocabulary is defined. While this is an optional field it is STRONGLY RECOMMENDED that all publishers use it to ensure that the meaning of their codes are fully understood by data users.
This value must be of type xsd:anyURI.
- @code
Either an OECD DAC, UN region code or (if code ‘99’ Reporting organisation is selected for recipient-region/@vocabulary) a code from your internal vocabulary. The codelist is determined by vocabulary attribute. The value in recipient-region/@code should appear within the Region codelist, if the vocabulary code 1 (‘OECD DAC’) is used.
This value must be of type xsd:string.
This value must be on the Region codelist, if the relevant vocabulary is used.
Example Usage¶
Example usage of recipient-region in context of recipient-region-budget element:
@code attribute declares a valid code (489) from the Region codelist.@vocabulary attribute declares a valid code (1) from the RegionVocabulary codelist.<recipient-region code="489" vocabulary="1" />
If a publisher uses a vocabulary of 99 (i.e. ‘Reporting Organisation’), then the @vocabulary-uri attribute should also be used, for example:
.. code-block:: xml
<recipient-region code=”A1” vocabulary=”99” vocabulary-uri=”http://example.com/vocab.html” />
Example of recipient-region in context of a complete recipient-region-budget element:
<recipient-region-budget status="2">
<recipient-region vocabulary="99" vocabulary-uri="http://example.com/vocab.html" code="A1" />
<period-start iso-date="2014-01-01" />
<period-end iso-date="2014-12-31" />
<value currency="USD" value-date="2014-01-01">25000000</value>
<budget-line ref="1234">
<value currency="USD" value-date="2014-01-01">2000000</value>
<narrative xml:lang="en">Budget Line</narrative>
</budget-line>
</recipient-region-budget>