Difference between revisions of "Data Dictionary"

From DE4A
Jump to navigation Jump to search
(Quality review)
Line 79: Line 79:
 
|1..n
 
|1..n
 
|Y/Y
 
|Y/Y
−
|
+
|Contains the data of each possible provision.
 
|}
 
|}
  
Line 96: Line 96:
 
| 1
 
| 1
 
|N/Y
 
|N/Y
−
|Level of administration territorial unit.
+
|Level of Administrative Territorial Unit.
 
'''Allowed values:'''
 
'''Allowed values:'''
  
Line 105: Line 105:
 
* lau: Local level  
 
* lau: Local level  
 
* edu: Educational level  
 
* edu: Educational level  
−
See [https://github.com/de4a-wp5/de4a-codelists codelists] in github for additional information.
 
 
|-
 
|-
 
|AtuCode
 
|AtuCode
Line 111: Line 110:
 
|1
 
|1
 
|N/Y
 
|N/Y
−
| Code of the administrative territory unit.  
+
| Code of the Administrative Territorial Unit.
  
 
'''Allowed values:'''
 
'''Allowed values:'''
Line 119: Line 118:
 
* Municipality for lau  
 
* Municipality for lau  
 
* Educational Organization for edu  
 
* Educational Organization for edu  
−
See [https://github.com/de4a-wp5/de4a-codelists codelists] in github for additional information.
 
 
|-
 
|-
 
|AtuLatinName
 
|AtuLatinName
Line 131: Line 129:
 
|1
 
|1
 
|N/Y
 
|N/Y
−
|Identifies the Data Owner in iso6523 format<br />Defines Party ID for all participants
+
|Identifies the Data Owner in iso6523 format. It defines Party Id for all participants. It must be unique.
−
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}  
 
'''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”  
+
* '''{PEPPOL ParticipantIdentifierScheme}:''' Must be the constant “iso6523-actorid-upis”  
 +
* '''{Domain Scheme}:''' Identifies ICD value, must be a 4-digit UNIQUE number in PEPPOL
 +
* '''{Party Id}:''' Identifies DE4A Partner, consisting of:
 +
** 2 letters for country
 +
** 2 digits for entity type → 00 if entity is a DE4A partner, 88 if not; for regional or local administrations, the entity type is 99
 +
** 7 digits for DE4A Partner. For regional or local administrations, it is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until reaching 7 digits.
  
−
'''{Domain Scheme}:''' Identifies ICD value, must be a 4-digit UNIQUE number in PEPPOL
+
Example of the Spanish Municipality of San Sebastian with LAU code 20069: '''ES990020069'''
  
−
'''{Party Id}:''' Identifies DE4A Partner, consisting of:
+
Example of the Dutch Province of Groningen with NUTS code NL11: '''NL990000011'''
  
−
* 2 letters for country
+
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
−
* 2 digits for entity type → 00 if entity is a DE4A partner, 88 if not
 
−
* 7 digits for 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''' 
+
For further information on the Domain Scheme values, see the [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
 
 
|-
 
|-
 
|DataOwnerPrefLabel
 
|DataOwnerPrefLabel
Line 183: Line 176:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Name of the required parameter for the requested evidence.
+
|Name of the required set of parameters for the requested evidence.
 
|-
 
|-
 
|Parameter
 
|Parameter
Line 258: Line 251:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
Line 264: Line 257:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 270: Line 263:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute
+
|Date and time when the message is created.
−
are created.
 
 
|-
 
|-
 
|ProcedureId
 
|ProcedureId
Line 277: Line 269:
 
|1
 
|1
 
|N/Y
 
|N/Y
−
|Metadata about a procedure or public service.  
+
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 
|-
 
|-
 
|DataEvaluator
 
|DataEvaluator
Line 283: Line 275:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Identifier will be used to address the evidence back from the DataOwner.  
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 289: Line 281:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Indentifier indicates the component responsible of issuing the evidence.  
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|RequestEvidenceIMItem  
 
|RequestEvidenceIMItem  
Line 315: Line 307:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Identifies DataOwner in format iso6523.<br />Define Party ID for all participants
+
|Identifies the DE4A participant (Data Evaluator or Data Owner) in iso6523 format. It defines Party Id for all participants. It must be unique.
−
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}  
 
'''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”  
+
* '''{PEPPOL ParticipantIdentifierScheme}:''' Must be the constant “iso6523-actorid-upis”  
 +
* '''{Domain Scheme}:''' Identifies ICD value, must be a 4-digit UNIQUE number in PEPPOL
 +
* '''{Party Id}:''' Identifies DE4A Partner, consisting of:
 +
** 2 letters for country
 +
** 2 digits for entity type → 00 if entity is a DE4A partner, 88 if not; for regional or local administrations, the entity type is 99
 +
** 7 digits for DE4A Partner. For regional or local administrations, it is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until reaching 7 digits.
  
−
'''{Domain Scheme}:''' Identifies ICD value, must be 4 UNIQUE digits in PEPPOL
+
Example of the Spanish Municipality of San Sebastian with LAU code 20069: '''ES990020069'''
  
−
'''{Party Id}:''' Identifies DE4A Partner, consisting of:
+
Example of the Dutch Province of Groningen with NUTS code NL11: '''NL990000011'''
  
−
* 2 letters country
+
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
−
* 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. 
+
For further information on the Domain Scheme values, see the [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
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
 
  
 
|-
 
|-
Line 343: Line 330:
 
|1
 
|1
 
|Y/N
 
|Y/N
−
|Name of the agent Data Owner.  
+
|Name of the DE4A participant (Data Evaluator or Data Owner).
 
|-
 
|-
 
|RedirectUrl
 
|RedirectUrl
Line 663: Line 650:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 675: Line 662:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 681: Line 668:
 
|1
 
|1
 
|N/Y
 
|N/Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|ResponseExtractEvidenceItem
 
|ResponseExtractEvidenceItem
Line 853: Line 840:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
Line 859: Line 846:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Version used and it will define the message structure.
+
|IEM version used.
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 871: Line 858:
 
|0..1
 
|0..1
 
|N/Y
 
|N/Y
−
|Metadata about a procedure or public service.
+
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 
|-
 
|-
 
|DataEvaluator
 
|DataEvaluator
Line 877: Line 864:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 883: Line 870:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|RequestEvidenceUSIItem
 
|RequestEvidenceUSIItem
Line 973: Line 960:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
Line 979: Line 966:
 
|1
 
|1
 
|Y
 
|Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 991: Line 978:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 997: Line 984:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
Line 1,054: Line 1,041:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
Line 1,060: Line 1,047:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 1,072: Line 1,059:
 
|0..1
 
|0..1
 
|N/Y
 
|N/Y
−
|Metadata about a procedure or public service.
+
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 
|-
 
|-
 
|DataEvaluator
 
|DataEvaluator
Line 1,078: Line 1,065:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 1,084: Line 1,071:
 
|1
 
|1
 
|Y/Y
 
|Y/Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|EventSubscripRequestItem
 
|EventSubscripRequestItem
Line 1,174: Line 1,161:
 
|1
 
|1
 
|Y
 
|Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 1,186: Line 1,173:
 
|1
 
|1
 
|Y
 
|Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 1,192: Line 1,179:
 
|1
 
|1
 
|Y
 
|Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|ResponseEventSubscriptionItem
 
|ResponseEventSubscriptionItem
Line 1,265: Line 1,252:
 
|1
 
|1
 
|Y
 
|Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 1,271: Line 1,258:
 
|1
 
|1
 
|Y
 
|Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|EventNotificationItem
 
|EventNotificationItem
Line 1,350: Line 1,337:
 
|1
 
|1
 
|Y
 
|Y
−
|Request message identifier (UUID format)
+
|Request identifier (UUID format). It is going to be the same during all interactions of this request.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
Line 1,356: Line 1,343:
 
|1
 
|1
 
|Y
 
|Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
Line 1,368: Line 1,355:
 
|0..1
 
|0..1
 
|N
 
|N
−
|Metadata about a procedure or public service.
+
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 
|-
 
|-
 
|DataEvaluator
 
|DataEvaluator
Line 1,374: Line 1,361:
 
|1
 
|1
 
|Y
 
|Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
Line 1,380: Line 1,367:
 
|1
 
|1
 
|Y
 
|Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for evidence is sent.
 
|-
 
|-
 
|RequestEvidenceLUItem
 
|RequestEvidenceLUItem

Revision as of 11:33, 19 December 2022

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

Name Type Cardinality Mandatory Field / Label Description
ResponseLookupRoutingInformation ResponseLookupRoutingInformationType 1 Y/Y Root element
ResponseItem ResponseItemType 1..n Y/Y Contains a list of available sources obtained.
Error ErrorType 1..n Y/Y Contains the response error.

Schema XSD

IAL.xsd

ResponseItemType

Location: //ResponseLookupRoutingInformation/ResponseItemType
Name Type Cardinality Mandatory Field / Label Description
ResponsePerCountry ResponsePerCountryType 1..n Y/Y Contains the data for each source obtained.

ResponsePerCountryType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType
Name Type Cardinality Mandatory Field / Label Description
CountryCode String 1 Y/Y The two-letter code of the DP country.

Format: ISO 3166-1 alfa-2

https://www.iso.org/obp/ui/

Provision ProvisionType 1..n Y/Y Contains the data of each possible provision.

ProvisionType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision
ComplexType ProvisionType.jpg
Name Type Cardinality Mandatory Field / Label Description
AtuLevel String 1 N/Y Level of Administrative 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 1 N/Y Code of the Administrative Territorial Unit.

Allowed values:

  • ISO 3166-1 alfa-2 for nuts0
  • Region for nuts1-3
  • Municipality for lau
  • Educational Organization for edu
AtuLatinName String 1 N/Y Name of the Administrative Territorial Unit.
DataOwnerId anyURI 1 N/Y Identifies the Data Owner in iso6523 format. It defines Party Id for all participants. It 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 the constant “iso6523-actorid-upis”
  • {Domain Scheme}: Identifies ICD value, must be a 4-digit UNIQUE number in PEPPOL
  • {Party Id}: Identifies DE4A Partner, consisting of:
    • 2 letters for country
    • 2 digits for entity type → 00 if entity is a DE4A partner, 88 if not; for regional or local administrations, the entity type is 99
    • 7 digits for DE4A Partner. For regional or local administrations, it is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until reaching 7 digits.

Example of the Spanish Municipality of San Sebastian with LAU code 20069: ES990020069

Example of the 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

For further information on the Domain Scheme values, see the codelists on the WP5 GitHub.

DataOwnerPrefLabel String 1 N/Y Name of the issuing DO from which the evidence is obtained.
ParameterSet ParameterSetType 0..n Y/Y Contains a list of necessary parameters for the requested evidence.

ParameterSetType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision/ProvisionType
Name Type Cardinality Mandatory Field / Label Description
Title String 1 Y/Y Name of the required set of parameters for the requested evidence.
Parameter ParameterType 1..n Y/Y Contains the data for each necessary parameter of the requested evidence.

ParameterType

Location: //ResponseLookupRoutingInformation/AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet
ComplexType ParameterType.jpg
Name Type Cardinality Mandatory Field / Label Description
Name String 1 Y/Y Name of the parameter
Optional Boolean 1 Y/Y Indicates whether the parameter is optional or not

ErrorType

Location: //ResponseLookupRoutingInformation
ComplexType ErrorType.jpg
Name Type Cardinality Mandatory Field / Label Description
Code String 1 Y/Y Code of the error occurred. See [FIX TABLE/DOCUMENT ERRORS]
Text String 1 Y/Y Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS]

RequestExtractMultiEvidenceIMType

ComplexType RequestExtractMultiEvidenceIMType.jpg 
Location: //RequestExtractMultiEvidenceIMType
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType 1 Y/Y Root element
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
SpecificationId String 1 Y/Y IEM version used
Timestamp Date 1 Y/Y Date and time when the message is created.
ProcedureId String 1 N/Y Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
DataEvaluator AgentType 1 Y/Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y/Y Identifies the Data Owner to whom the request for evidence is sent.
RequestEvidenceIMItem RequestEvidenceItemType 1..n Y/Y Evidence item list requested.

Schema XSD

common-types.xsd

AgentType

ComplexType AgentType.jpg 
Location: //RequestExtractMultiEvidenceIMType/AgentType
Name Type Cardinality Mandatory Field / Label Description
AgentUrn anyURI 1 Y/Y Identifies the DE4A participant (Data Evaluator or Data Owner) in iso6523 format. It defines Party Id for all participants. It 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 the constant “iso6523-actorid-upis”
  • {Domain Scheme}: Identifies ICD value, must be a 4-digit UNIQUE number in PEPPOL
  • {Party Id}: Identifies DE4A Partner, consisting of:
    • 2 letters for country
    • 2 digits for entity type → 00 if entity is a DE4A partner, 88 if not; for regional or local administrations, the entity type is 99
    • 7 digits for DE4A Partner. For regional or local administrations, it is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until reaching 7 digits.

Example of the Spanish Municipality of San Sebastian with LAU code 20069: ES990020069

Example of the 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

For further information on the Domain Scheme values, see the codelists on the WP5 GitHub.

AgentName String 1 Y/N Name of the DE4A participant (Data Evaluator or Data Owner).
RedirectUrl String 0..1 N/Y Redirect URL to Data Owner.

RequestEvidenceItemType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType
ComplexType RequestEvidenceItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y/Y Unique evidence request ID (UUID format)
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.
Format:

urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>

Allowed values for <canonical-evidence-type-idtoken>:

  • HigherEducationDiploma
  • DomicileRegistrationEvidence
  • BirthCertificate
  • MarriageCertificate
  • CompanyRegistration

See codelists in github for additional information.

RequestGrounds RequestGroundsType 1 Y/Y Request grounds to request evidence.
AdditionalParameter AdditionalParameterType 0..n N/Y Contains each additional parameter necessary to request the evidence.

DataRequestSubjectCVType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject
ComplexType DataRequestSubjectCVType.jpg
Name Type Cardinality Mandatory Field / Label Description
DataSubjectPerson NaturalPersonIdentifierType 1 Y/Y Contains the identifying details of the person to obtain the evidence.
DataSubjectCompany LegalPersonIdentifierType 1 Y/Y Contains the identifying details of the company to obtain the evidence.
DataSubjectRepresentative NaturalPersonIdentifierType 0..1 N/Y Contains the identifying details of the representative to obtain the evidence.

NaturalPersonIdentifierType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/NaturalPersonIdentifierType
ComplexType NaturalPersonIdentifierType.jpg
Name Type Cardinality Mandatory Field / Label Description
PersonIdentifier String 1 Y/N Unique identifier for the natural person as defined by the eIDAS Regulation.
FirstName String 1 Y/N Current given names of the natural person.
FamilyName String 1 Y/N Current family name of the natural person.
DateOfBirth Date 1 Y/Y Date of birth for the natural person.

Format: YYYY-MM-DD

Gender String 0..1 N/Y Gender of the natural person.

Allowed values:

  • Male
  • Female
  • Unspecified

See codelists in github for additional information.

BitrhName String 0..1 N/N First name(s) and family name(s) of the natural person at birth.
PlaceOfBirth String 0..1 N/N Place of birth for a natural person.
CurrentAddress String 0..1 N/N Current address of the natural person as a base64 encoded string.

LegalPersonIdentifierType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/LegalPersonIdentifierType
ComplexType LegalPersonIdentifierType.jpg
Name Type Cardinality Mandatory Field / Label Description
LegalPersonIdentifier String 1 Y/N Unique identifier for the legal person as defined by the eIDAS Regulation.
LegalName String 1 Y/N Current legal name for the legal person or organisation.
LegalAddress String 0..1 N/N The address the legal person has registered with the MS authority or operating address if not registered.  

For a company this should be the registered address within the MS issuing the eID as a base64 encoded string.

VATRegistration String 0..1 N/N VAT - VAT registration number.
TaxReference String 0..1 N/N TAX-Ref - tax reference number.
D-2012-17-EUIdentifier String 0..1 N/N D-2012/17/EU - the identifier used under directive 2012/17/EU
LEI String 0..1 N/N Legal Entity Identifier.
EORI String 0..1 N/N Economic Operator Registration and Identification.
SEED String 0..1 N/N System for Exchange of Excise Data.
SIC String 0..1 N/N Standard Industrial Classification.

RequestGroundsType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/RequestGrounds
ComplexType RequestGroundsType.jpg
Name Type Cardinality Mandatory Field / Label Description
LawELIPermanentLink anyURI 1 Y/Y Permanent link allowing access to the system.
ExplicitRequest token 1 Y/Y Consent allowing access to the system.

Allowed values:

SDGR14

See codelists in github for additional information.

AdditionalParameterType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/AdditionalPatameter
Name Type Cardinality Mandatory Field / Label Description
Label String 1 Y/Y Label identifying the required parameter.
Type String 1 Y/Y Type of the required parameter.

Allowed values:

  • Date → Date tye
  • InputText → Input Text type
  • YesNo → Selector Yes/No type

See codelists in github for additional information.

Value String 1 Y/Y Value of the required parameter.

ResponseExtractMultiEvidenceType

ComplexType ResponseExtractMultiEvidenceType.jpg 
Location: //ResponseExtractMultiEvidenceType
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceIMType ResponseExtractMultiEvidenceType 1 Y/Y Root element
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
Timestamp Date 1 Y/Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
DataEvaluator AgentType 1 Y/Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 N/Y Identifies the Data Owner to whom the request for evidence is sent.
ResponseExtractEvidenceItem ResponseExtractEvidenceItemType 1..n Y/Y Evidence item list requested.

Schema XSD

common-types.xsd

ResponseExtractEvidenceItemType

Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem
ComplexType ResponseExtractEvidenceItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y/Y Unique evidence request ID (UUID format)
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.

Format:

urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>

Allowed values for <canonical-evidence-type-idtoken>:

  • HigherEducationDiploma
  • DomicileRegistrationEvidence
  • BirthCertificate
  • MarriageCertificate
  • CompanyRegistration

See codelists in github for additional information.

CanonicalEvidence CanonicalEvidenceType 1 Y/Y Canonical Evidence obtained.
DomesticEvidence DomesticEvidenceType 0..n Y/Y Contains the data of each domestic evidences obtained.
Error ErrorType 1..n N/Y Contains the data for each error that occurred.

CanonicalEvidenceType

Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/CanonicalEvidence
ComplexType CanonicalEvidenceType.jpg

DomesticEvidenceType

Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence
Name Type Cardinality Mandatory Field / Label Description
IssuingType Token 1 Y/Y Indicates what type of evidence it is:

OriginalIssuing: Original Evidence

MultinlingualFormIssuing: Multilingual evidence

MimeType normalizedString 1 Y/Y Contains the MIME Type of the canonical evidence.
https://docs.oasis-open.org/ubl/os-UBL-2.1/cva/UBL-DefaultDTQ-2.1.html#d4e1
DataLanguage language 1 Y/N Contains the language of the canonical evidence.
Values conform to RFC 3066, allowed values:
Conformity to ISO 639

Conformity to ISO 3166

Languages registered by the Internet Assigned Numbers Authority (IANA)

Expression pattern: [a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*

See codelists in github for additional information.

EvidenceData base64Binary 1 Y/Y Contains the domestic that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64.
AdditionalInfo TextType 0..1 N/N Contains additional information about domestic evidence.

TextType

Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence/AdditionalInfo
Name Type Cardinality Mandatory Field / Label Description
languageID language 0..1 N/Y The identifier of the language used in the content.
languageLocaleID normalizedString 0..1 N/Y The identification of the locale of the language.

RequestExtractMultiEvidenceUSIType

Location: //ResponseExtractMultiEvidenceUSIType
ComplexType RequestExtractMultiEvidenceUSIType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceType 1 Y/Y Root element
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
SpecificationId String 1 Y/Y IEM version used.
Timestamp Date 1 Y/Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
ProcedureId String 0..1 N/Y Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
DataEvaluator AgentType 1 Y/Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y/Y Identifies the Data Owner to whom the request for evidence is sent.
RequestEvidenceUSIItem RequestEvidenceUSIItemType 1..n Y/Y Evidence item list requested

Schema XSD

common-types.xsd

RequestExtractMultiEvidenceType

Location: //ResponseExtractMultiEvidenceUSIType/RequestEvidenceUSIItem
ComplexType RequestEvidenceUSIItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y/Y Unique evidence request ID (UUID format)
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.

Format:

urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
Allowed values for <canonical-evidence-type-idtoken>:

  • HigherEducationDiploma
  • DomicileRegistrationEvidence
  • BirthCertificate
  • MarriageCertificate
  • CompanyRegistration

See codelists in github for additional information.

RequestGrounds RequestGrounds 1 Y/Y Request grounds to request evidence.
AdditionalParameter AdditionalParameterType 0..n N/Y Contains each additional parameter necessary to request the evidence.
DataEvaluatorURL anyUri 1 Y/Y Indicates the redirection url to return the user to the e-procedure portal of the data evaluator

RedirectUserType

Location: //RedirectUserType
ComplexType RedirectUserType.jpg
Name Type Cardinality Mandatory Field / Label Description
RedirectUserType RedirectUserType 1 Y/Y Root element
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
SpecificationId String 1 Y IEM version used
Timestamp Date 1 Y/Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
DataEvaluator AgentType 1 Y/Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y/Y Identifies the Data Owner to whom the request for evidence is sent.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.

Format:

urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>

Allowed values for <canonical-evidence-type-idtoken>:

  • HigherEducationDiploma
  • DomicileRegistrationEvidence
  • BirthCertificate
  • MarriageCertificate
  • CompanyRegistration

See codelists in github for additional information.

RedirectURL anyURI 1 Y/Y Indicates the redirection url for the user to choose and preview the evidence.
Error ErrorType 0..n N/Y Contains the response error.

Schema XSD

common-types.xsd

RequestEventSubscriptionType

Location: //RequestEventSubscriptionType
ComplexType RequestEventSubscriptionType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestEventSubscriptionType RequestEventSubscriptionType 1 Y/Y Root element
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
SpecificationId String 1 Y/Y IEM version used
Timestamp Date 1 Y/Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
ProcedureId String 0..1 N/Y Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
DataEvaluator AgentType 1 Y/Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y/Y Identifies the Data Owner to whom the request for evidence is sent.
EventSubscripRequestItem EventSubscripRequestItemType 1..n Y/Y Subscription item list requested.

Schema XSD

common-types.xsd

EventSubscripRequestItemType

Location: //RequestEventSubscriptionType/EventSubscripRequestItem
ComplexType EventSubscripRequestItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId string 1 Y/Y Unique evidence request ID (UUID format)
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEventCatalogUri anyUri 1 Y/Y
SubscriptionPeriod TimePeriodType 0..1 Y/Y Period dates of the subscription

TimePeriodType

Location: //RequestEventSubscriptionType/EventSubscripRequestItem/SubscriptionPeriod
ComplexType TimePeriodType.jpg
Name Type Cardinality Mandatory Field / Label Description
StartDate dateTime 1 Y/Y Subscription Start Date
EndDate dateTime 0..1 N/Y Subscription End Date

ResponseEventSubscriptionType

Location: //ResponseEventSubscriptionType
ComplexType ResponseEventSubscriptionType.jpg
Name Type Cardinality Mandatory Field / Label Description
ResponseEventSubscriptionType ResponseEventSubscriptionType 1 Y Root element
RequestId String 1 Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
Timestamp Date 1 Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
DataEvaluator AgentType 1 Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y Identifies the Data Owner to whom the request for evidence is sent.
ResponseEventSubscriptionItem ResponseEventSubscriptionItemType 1..n Y Subscription item list requested.

Schema XSD

common-types.xsd

ResponseEventSubscriptionItemType

Location: //ResponseEventSubscriptionType/ResponseEventSubscriptionItem
ComplexType ResponseEventSubscriptionItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId string 1 Y Unique evidence request ID (UUID format)
CanonicalEventCatalogUri anyUri 1 Y
SubscriptionPeriod TimePeriodType 1 Y Period dates of the subscription

EventNotificationType

Location: //EventNotificationType
ComplexType EventNotificationType.jpg
Name Type Cardinality Mandatory Field / Label Description
EventNotificationType EventNotificationType 1 Y Root element
NotificationId String 1 Y Request notification identifier
Timestamp Date 1 Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
DataEvaluator AgentType 1 Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y Identifies the Data Owner to whom the request for evidence is sent.
EventNotificationItem EventNotificationItemType 1..n Y Evidence item list requested.

Schema XSD

common-types.xsd

EventNotificationItemType

Location: //EventNotificationType/EventNotificationItem
ComplexType EventNotificationItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
NotificationItemId string 1 Y Unique notification ID
EventId string 1 Y Unique event ID
EventSubject DataRequestSubjectCVType 1 Y Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEventCatalogUri anyUri 1 Y
EventDate Datetime 1 Y Date of the event notification
RelatedEventSubject DataRequestSubjectCVType 0..n Y

RequestExtractMultiEvidenceLUType

Location: //RequestExtractMultiEvidenceLUType
ComplexType RequestExtractMultiEvidenceLUType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType 1 Y Root element
RequestId String 1 Y Request identifier (UUID format). It is going to be the same during all interactions of this request.
SpecificationId String 1 Y IEM version used
Timestamp Date 1 Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
ProcedureId String 0..1 N Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
DataEvaluator AgentType 1 Y Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
DataOwner AgentType 1 Y Identifies the Data Owner to whom the request for evidence is sent.
RequestEvidenceLUItem RequestEvidenceLUItemType 1..n Y Evidence item list requested.

Schema XSD

common-types.xsd

RequestEvidenceLUItemType

Location: //RequestExtractMultiEvidenceLUType/RequestEvidenceLUItem
ComplexType RequestEvidenceLUItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y Unique evidence request ID (UUID format)
DataRequestSubject DataRequestSubjectCVType 1 Y Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEvidenceTypeId String 1 Y Identifier of the canonical evidence type.

Format:

urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
Allowed values for <canonical-evidence-type-idtoken>:

  • HigherEducationDiploma
  • DomicileRegistrationEvidence
  • BirthCertificate
  • MarriageCertificate
  • CompanyRegistration

See codelists in github for additional information.

RequestGrounds RequestGrounds 1 Y Request grounds to request evidence.
AdditionalParameter AdditionalParameterType 0..n N/Y Contains each additional parameter necessary to request the evidence.
EventNotificationRef String 1 Y Reference of the notification event

ResponseErrorType

Location: //ResponseErrorType
ComplexType ResponseErrorType.jpg
Name Type Cardinality Mandatory Field / Label Description
Ack boolean 1 Y/Y
Error ErrorType 0..n N/Y Error

Schema XSD

common-types.xsd

Retrieved from ‘https://wiki.de4a.eu/index.php?title=Data_Dictionary&oldid=5711’