Data Dictionary

This document contains a basic detail about the messages exchanged in every step of the patterns for this iteration. More detailed information is available in the schema definition files.

RequestLookupRoutingInformationType

All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode.

Detailed information is available in ‘IAL Technical Design’ Document.

ResponseLookupRoutingInformationType

Location	Name	Type	Format	Mandatory	Description
//ResponseLookupRoutingInformation	Not applicable	ResponseLookupRoutingInformationType	Not apply	Y	Root element

ResponseItemType

Location	Name	Type	Format	Mandatory	Description
//ResponseLookupRoutingInformation	ResponseItem	ResponseItemType	Not apply	Y	Contains a list of available sources obtained.
//ResponseLookupRoutingInformation /ResponseItemType	ResponsePerCountry	ResponsePerCountryType	Cardinality 1..∞	Y	Contains the data for each source obtained.

ResponsePerCountryType

Location	Name	Type	Format	Mandatory	Description
//ResponseLookupRoutingInformation /ResponsePerCountryType	CountryCode	String	Attribute	Y	The two-letter code of the DP country. Format: ISO 3166-1 alfa-2 https://www.iso.org/obp/ui/
//ResponseLookupRoutingInformation /ResponsePerCountryType	Provision	ProvisionType	Cardinality 1..∞	Y

ProvisionType

Location: //ResponseLookupRoutingInformation/ResponsePerCountryType/Provision/ProvisionItem

Name	Type	Format	Mandatory	Description
AtuLevel	String	Enumerated	N	Level of administration territorial unit. Allowed values: nuts0 à National level nuts1 à Regional/Province level nuts2 à Regional/Province level nuts3 à Regional/Province level lau à Local level edu à Educational level
AtuCode	String	Not apply	N	Code of the administrative territory unit.   Allowed values: ISO 3166-1 alfa-2 à For nuts0 Region à For nuts1-3 Municipality à For lau Educational Organization à For edu
AtuLatinName	String	Not apply	N	Name of the administrative territorial unit.
DataOwnerId	anyURI	Not apply	N	Identifies DataOwner in format iso6523. It defines Party ID for all participants MUST be UNIQUE Format: {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id} iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15} {PEPPOL ParticipantIdentifierScheme} à Must be a constant “iso6523-actorid-upis” {Domain Scheme} à Identifies ICD value, must be 4 UNIQUE digits in PEPPOL {Party Id} à Identifies DE4A Partner, consisting of: 2 letters country 2 digits entity type à 00 if entity is a DE4A partner, 88 if not 7 digits DE4A Partner For regional or local administrations, the entity type is 99 and the 7 digit number is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until 7 digits. Example Spanish Municipality of San Sebastian with LAU code 20069: ES990020069 Example of Dutch Province of Groningen with NUTS code NL11: NL990000011 https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
DataOwnerPrefLabel	String	Not apply	N	Name of the issuing DO from which the evidence is obtained.
ParameterSet	ParameterSetType	Not apply	Y	Contains a list of necessary parameters for the requested evidence.

ParameterSetType

Location	Name	Type	Format	Mandatory	Description
//ResponseLookupRoutingInformation /ResponsePerCountryType /Provision /ProvisionItem /ParameterSet	Title	String	Not apply	Y	Name of the required parameter for the requested evidence.
//ResponseLookupRoutingInformation /ResponsePerCountryType /Provision /ProvisionItem /ParameterSet	Parameter	ParameterType	Cardinality 1..∞	Y	Contains the data for each necessary parameter of the requested evidence.