location-id

iati-activities/iati-activity/location/location-id

This is the reference page for the XML element location-id. See also the relevant overview page: Geography

Definition

A unique code describing the location according to a recognised gazetteer or administrative boundary repository. Administrative areas should only be reported here if the location being defined is the administrative area itself. For describing the administrative area/s within which a more specific location falls the location/administrative element should be used.

Rules

This element may occur any number of times.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

Attributes

@code

A code from the gazetteer or administrative boundary repository specified by the vocabulary

This attribute is required.

This value must be of type xsd:string.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

@vocabulary

An IATI code for a recognised gazetteer or administrative boundary repository.

This attribute is required.

This value must be of type xsd:string.

This value must be on the GeographicVocabulary codelist.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

Example Usage

Example usage of location-id within a location of an iati-activity..

The @vocabulary attribute declares a valid code (G1) from the GeographicVocabulary codelist.
An example value of 1453782 from that vocabulary is declared in the @code attribute.
  <location ref="AF-KAN">
   <location-reach code="1" />    
   <location-id vocabulary="G1" code="1453782" />
   <name>
  <narrative>Location name</narrative>
   </name>
   <description>
  <narrative>Location description</narrative>
   </description>
   <activity-description>
  <narrative>A description that qualifies the activity taking place at the location.</narrative>
   </activity-description>
   <administrative vocabulary="G1" level="1" code="1453782" />
   <point srsName="http://www.opengis.net/def/crs/EPSG/0/4326">
    <pos>31.616944 65.716944</pos>
   </point>
   <exactness code="1"/>
   <location-class code="2"/>
   <feature-designation code="ADMF"/>
  </location>

Note: If the GeographicVocabulary G2 (Open Street Map) is used, then the @code value should be of the form <OSM element>/<OSM identifier>

The OSM element will be a node, way or relation.

Examples:
  • node/1234567
  • way/1234567
  • relation/1234567
<location-id vocabulary="G2" code="node/25524229" />

Changelog

2.01

Freetext is no longer allowed within this element.

1.04

New in 1.04
The location-id element was introduced in 1.04 to replace the gazetteer-entry element which was deprecated in 1.04

Developer tools

Find the source of this documentation on github: