Difference between revisions of "Data Dictionary"

From DE4A
Jump to navigation Jump to search
m (Quality review)
 
(85 intermediate revisions by 3 users not shown)
Line 6: Line 6:
 
Detailed information is available in ‘IAL Technical Design’ Document.  
 
Detailed information is available in ‘IAL Technical Design’ Document.  
  
−
=== ResponseLookupRoutingInformationType ===
+
== ResponseLookupRoutingInformationType ==
 +
[[File:Element ResponseLookupRoutingInformation.jpg|frame|alt=|none]]
 
{| class="wikitable"
 
{| class="wikitable"
−
|+[[File:Element ResponseLookupRoutingInformation.jpg|left|frame]]
 
−
!Location
 
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
−
!Mandatory
+
!Mandatory Field / Label
 
!Description
 
!Description
 
|-
 
|-
−
|//ResponseLookupRoutingInformation
+
|ResponseItem
−
|Not applicable
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseItemType ResponseItemType]
−
|ResponseLookupRoutingInformationType
+
|1..n
−
|Not apply
+
|Y/Y
−
|Y
+
|Contains a list of available sources obtained.
−
|Root element
+
|-
 +
|Error
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
 +
|1..n
 +
|Y/Y
 +
|Contains a list with the descriptions of the errors if one or more have occurred.
 
|}
 
|}
 +
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/IAL.xsd IAL.xsd]
  
 
=== ResponseItemType ===
 
=== ResponseItemType ===
 +
'''Location:''' //ResponseLookupRoutingInformation/ResponseItemType
 +
[[File:ComplexType ResponseItemType.jpg|frame|alt=|none]]
 
{| class="wikitable"
 
{| class="wikitable"
−
|+[[File:ComplexType ResponseItemType.jpg|left|frame]]
+
|+
−
!Location
 
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
−
!Mandatory
+
!Mandatory Field / Label
 
!Description
 
!Description
 
|-
 
|-
−
|//ResponseLookupRoutingInformation
 
−
|ResponseItem
 
−
|ResponseItemType
 
−
|Not apply
 
−
|Y
 
−
|Contains a list of available sources obtained.
 
−
|-
 
−
|//ResponseLookupRoutingInformation/ ResponseItemType
 
 
|ResponsePerCountry
 
|ResponsePerCountry
−
|ResponsePerCountryType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponsePerCountryType ResponsePerCountryType]
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
−
|Contains the data for each source obtained.  
+
|Contains the data for each source obtained.
 
|}
 
|}
  
 
=== ResponsePerCountryType ===
 
=== ResponsePerCountryType ===
 +
'''Location:''' //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType
 +
[[File:ComplexType ResponsePerCountryType.jpg|link=link=Special:FilePath/ComplexType_ResponsePerCountryType|alt=|frame|none]]
 
{| class="wikitable"
 
{| class="wikitable"
−
|+[[File:ComplexType ResponsePerCountryType.jpg|link=link=Special:FilePath/ComplexType_ResponsePerCountryType|alt=|left|frame]]
+
|+
−
!Location
 
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
−
!Mandatory
+
!Mandatory Field / Label
 
!Description
 
!Description
 
|-
 
|-
−
|//ResponseLookupRoutingInformation/ResponsePerCountryType
 
 
|CountryCode
 
|CountryCode
 
|String
 
|String
−
|Attribute
+
|1
−
|Y
+
|Y/Y
 
|The two-letter code of the DP country.  
 
|The two-letter code of the DP country.  
 
Format: ISO 3166-1 alfa-2  
 
Format: ISO 3166-1 alfa-2  
  
−
https://www.iso.org/obp/ui/  
+
https://www.iso.org/obp/ui/
 
|-
 
|-
−
|//ResponseLookupRoutingInformation/ResponsePerCountryType
 
 
|Provision
 
|Provision
−
|ProvisionType
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ProvisionType ProvisionType]
−
|Cardinality 1..∞
+
|1..n
 +
|Y/Y
 +
|Contains the data of each possible provision.
 +
|}
 +
 
 +
===ProvisionType===
 +
'''Location:''' //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision
 +
[[File:ComplexType ProvisionType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!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 [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|DataOwnerPrefLabel
 +
|String
 +
|1
 +
|N/Y
 +
|Name of the issuing DO from which the evidence is obtained.
 +
|-
 +
|ParameterSet
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ParameterSetType ParameterSetType]
 +
|0..n
 +
|Y/Y
 +
|Contains a list of necessary parameters for the requested evidence.
 +
 
 +
|}
 +
 
 +
===ParameterSetType===
 +
'''Location:''' //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision/ProvisionType
 +
[[File:ComplexType ParameterSetType.jpg|alt=|frame|none]]
 +
{| class="wikitable"
 +
|+
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|Title
 +
|String
 +
|1
 +
|Y/Y
 +
|Name of the required set of parameters for the requested evidence.
 +
|-
 +
|Parameter
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ParameterType ParameterType]
 +
|1..n
 +
|Y/Y
 +
|Contains the data for each necessary parameter of the requested evidence.
 +
|}
 +
 
 +
=== ParameterType ===
 +
Location: //ResponseLookupRoutingInformation/AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet
 +
[[File:ComplexType ParameterType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!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
 +
[[File:ComplexType ErrorType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|Code
 +
|String
 +
|1
 +
|Y/Y
 +
|Code of the error occurred. See [[DE4A Logs and error messages it2]]
 +
|-
 +
|Text
 +
|String
 +
|1
 +
|Y/Y
 +
|Text defining the above code. See [[DE4A Logs and error messages it2]]
 +
|}
 +
 
 +
== RequestExtractMultiEvidenceIMType ==
 +
[[File:ComplexType RequestExtractMultiEvidenceIMType.jpg|none|frame]]
 +
Location: //RequestExtractMultiEvidenceIMType
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y/Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|SpecificationId
 +
|String
 +
|1
 +
|Y/Y
 +
|IEM version used
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y/Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|ProcedureId
 +
|String
 +
|1
 +
|N/Y
 +
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType 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
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y/Y
 +
|Identifies the Data Owner to whom the request for evidence is sent.
 +
|-
 +
|RequestEvidenceIMItem
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEvidenceItemType RequestEvidenceItemType]
 +
|1..n
 +
|Y/Y
 +
|List of requested canonical evidence types
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== AgentType ===
 +
[[File:ComplexType AgentType.jpg|none|frame]]
 +
Location: //RequestExtractMultiEvidenceIMType/AgentType
 +
{| class="wikitable"
 +
!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 [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
 
 +
|-
 +
|AgentName
 +
|String
 +
|1
 +
|Y/N
 +
|Name of the DE4A participant (Data Evaluator or Data Owner). Based on the schema "<nowiki>https://data.europe.eu/semanticassets/ns/cv/common/dataTypes-2.0.0#</nowiki>"
 +
|-
 +
|RedirectUrl
 +
|String
 +
|0..1
 +
|N/Y
 +
|URL of the web page of origin. It is only filled in by the Data Evaluator in the context of the USI pattern, so that the Data Owner knows where to return the User once the preview has been completed in the DO portal.
 +
|}
 +
 
 +
=== RequestEvidenceItemType ===
 +
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType
 +
[[File:ComplexType RequestEvidenceItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestItemId
 +
|String
 +
|1
 +
|Y/Y
 +
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 +
 
 +
|-
 +
|DataRequestSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|1
 +
|Y/Y
 +
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 +
|-
 +
|CanonicalEvidenceTypeId
 +
|String
 +
|1
 +
|Y/Y
 +
|Identifier of the canonical evidence type.<br />'''Format:'''
 +
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
 +
 
 +
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|RequestGrounds
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGroundsType RequestGroundsType]
 +
|1
 +
|Y/Y
 +
|Legal grounds justifying the request for evidence and supporting the applicant.
 +
|-
 +
|AdditionalParameter
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
 +
|0..n
 +
|N/Y
 +
|Contains each additional parameter necessary to request the evidence.
 +
|}
 +
 
 +
=== DataRequestSubjectCVType ===
 +
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject
 +
[[File:ComplexType DataRequestSubjectCVType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|DataSubjectPerson
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#NaturalPersonIdentifierType NaturalPersonIdentifierType]
 +
|1
 +
|Y/Y
 +
|Contains the identifying details of the person to whom the evidence relates. Based on the schema "<nowiki>http://eidas.europa.eu/attributes/naturalperson</nowiki>".
 +
 
 +
|-
 +
|DataSubjectCompany
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#LegalPersonIdentifierType LegalPersonIdentifierType]
 +
|1
 +
|Y/Y
 +
|Contains the identifying details of the company to which the evidence or event relates. Based on the schema "<nowiki>http://eidas.europa.eu/attributes/legalperson</nowiki>".
 +
|-
 +
|DataSubjectRepresentative
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#NaturalPersonIdentifierType NaturalPersonIdentifierType]
 +
|0..1
 +
|N/Y
 +
|Contains the identifying details of the company representative to which the evidence or event relates. Based on the schema "<nowiki>http://eidas.europa.eu/attributes/naturalperson</nowiki>".
 +
|}
 +
 
 +
=== NaturalPersonIdentifierType ===
 +
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/NaturalPersonIdentifierType
 +
[[File:ComplexType NaturalPersonIdentifierType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!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 of the natural person.
 +
 
 +
Format: '''YYYY-MM-DD'''
 +
|-
 +
|Gender
 +
|String
 +
|0..1
 +
|N/Y
 +
|Gender of the natural person.
 +
 
 +
'''Allowed values:'''
 +
 
 +
* Male
 +
* Female
 +
* Unspecified
 +
|-
 +
|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 of the 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
 +
[[File:ComplexType LegalPersonIdentifierType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!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
 +
|Value Addex Tax registration number
 +
|-
 +
|TaxReference
 +
|String
 +
|0..1
 +
|N/N
 +
|Tax reference number
 +
|-
 +
|D-2012-17-EUIdentifier
 +
|String
 +
|0..1
 +
|N/N
 +
|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
 +
[[File:ComplexType RequestGroundsType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|LawELIPermanentLink
 +
|anyURI
 +
|1
 +
|Y/Y
 +
|Permanent link to the european law that allows a DE to request the corresponding evidence, identified by the European Legislation Identifier (ELI).
 +
 
 +
|-
 +
|ExplicitRequest
 +
|token
 +
|1
 +
|Y/Y
 +
|Explicit consent made by the User to allow the DE to request the appropriate evidence through the DE4A system. Requirement imposed by article 14 of the SDG Regulation.
 +
|}
 +
 
 +
=== AdditionalParameterType ===
 +
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/AdditionalPatameter
 +
{| class="wikitable"
 +
!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 type
 +
* InputText → Input Text type
 +
* YesNo → Selector Yes/No type
 +
|-
 +
|Value
 +
|String
 +
|1
 +
|Y/Y
 +
|Value of the required parameter.
 +
|}
 +
 
 +
== ResponseExtractMultiEvidenceType ==
 +
[[File:ComplexType ResponseExtractMultiEvidenceType.jpg|none|frame]]
 +
Location: //ResponseExtractMultiEvidenceType
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y/Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y/Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType 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
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|N/Y
 +
|Identifies the Data Owner to whom the request for evidence is sent.
 +
|-
 +
|ResponseExtractEvidenceItem
 +
|ResponseExtractEvidenceItemType
 +
|1..n
 +
|Y/Y
 +
|List of requested canonical evidence types
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== ResponseExtractEvidenceItemType ===
 +
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem
 +
[[File:ComplexType ResponseExtractEvidenceItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestItemId
 +
|String
 +
|1
 +
|Y/Y
 +
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 +
 
 +
|-
 +
|DataRequestSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|1
 +
|Y/Y
 +
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 +
|-
 +
|CanonicalEvidenceTypeId
 +
|String
 +
|1
 +
|Y/Y
 +
|Identifier of the canonical evidence type.<br />'''Format:'''
 +
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
 +
 
 +
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|CanonicalEvidence
 +
|CanonicalEvidenceType
 +
|1
 +
|Y/Y
 +
|Evidence retrieved from the DO in its corresponding canonical format.
 +
|-
 +
|DomesticEvidence
 +
|DomesticEvidenceType
 +
|0..n
 +
|Y/Y
 +
|Contains the data for each piece of national evidence retrieved from the DO in the original format in which they are issued.
 +
|-
 +
|Error
 +
|ErrorType
 +
|1..n
 +
|N/Y
 +
|Contains a list with the descriptions of the errors if one or more have occurred.
 +
|}
 +
 
 +
=== CanonicalEvidenceType ===
 +
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/CanonicalEvidence
 +
[[File:ComplexType CanonicalEvidenceType.jpg|none|frame]]
 +
 
 +
=== DomesticEvidenceType ===
 +
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|IssuingType
 +
|Token
 +
|1
 +
|Y/Y
 +
|Indicates the format of the evidence:
 +
 
 +
* '''OriginalIssuing:''' Original format
 +
* '''MultinlingualFormIssuing:''' Multilingual format
 +
 
 +
|-
 +
|MimeType
 +
|normalizedString
 +
|1
 +
|Y/Y
 +
|Contains the MIME Type of the canonical evidence.<br />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 <nowiki>RFC 3066</nowiki>, 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})*
 +
|-
 +
|EvidenceData
 +
|base64Binary
 +
|1
 +
|Y/Y
 +
|Contains the domestic evidence that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64.
 +
|-
 +
|AdditionalInfo
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TextType TextType]
 +
|0..1
 +
|N/N
 +
|Contains additional information about the domestic evidence.
 +
|}
 +
 
 +
=== TextType ===
 +
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence/AdditionalInfo
 +
{| class="wikitable"
 +
!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
 +
[[File:ComplexType RequestExtractMultiEvidenceUSIType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y/Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|SpecificationId
 +
|String
 +
|1
 +
|Y/Y
 +
|IEM version used.
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y/Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|ProcedureId
 +
|String
 +
|0..1
 +
|N/Y
 +
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType 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
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y/Y
 +
|Identifies the Data Owner to whom the request for evidence is sent.
 +
|-
 +
|RequestEvidenceUSIItem
 +
|RequestEvidenceUSIItemType
 +
|1..n
 +
|Y/Y
 +
|List of requested canonical evidence types
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== RequestExtractMultiEvidenceType ===
 +
Location: //ResponseExtractMultiEvidenceUSIType/RequestEvidenceUSIItem
 +
[[File:ComplexType RequestEvidenceUSIItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestItemId
 +
|String
 +
|1
 +
|Y/Y
 +
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 +
 
 +
|-
 +
|DataRequestSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|1
 +
|Y/Y
 +
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 +
|-
 +
|CanonicalEvidenceTypeId
 +
|String
 +
|1
 +
|Y/Y
 +
|Identifier of the canonical evidence type.<br />'''Format:'''
 +
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
 +
 
 +
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|RequestGrounds
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
 +
|1
 +
|Y/Y
 +
|Legal grounds justifying the request for evidence and supporting the applicant.
 +
|-
 +
|AdditionalParameter
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType 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
 +
[[File:ComplexType RedirectUserType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y/Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|SpecificationId
 +
|String
 +
|1
 
|Y
 
|Y
−
|
+
|IEM version used
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y/Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType 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
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType 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.<br />'''Format:'''
 +
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
 +
 
 +
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|RedirectURL
 +
|anyURI
 +
|1
 +
|Y/Y
 +
|Indicates the URL of the DO portal where to send the User to choose and preview the evidence.
 +
|-
 +
|Error
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
 +
|0..n
 +
|N/Y
 +
|Contains the description of the error if one has occurred.
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
== RequestEventSubscriptionType ==
 +
Location: //RequestEventSubscriptionType
 +
[[File:ComplexType RequestEventSubscriptionType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y/Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|SpecificationId
 +
|String
 +
|1
 +
|Y/Y
 +
|IEM version used
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y/Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|ProcedureId
 +
|String
 +
|0..1
 +
|N/Y
 +
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y/Y
 +
|Identifies the Data Evaluator who is making the request for subscription. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 +
|-
 +
|DataOwner
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y/Y
 +
|Identifies the Data Owner to whom the request for subscription is sent.
 +
|-
 +
|EventSubscripRequestItem
 +
|EventSubscripRequestItemType
 +
|1..n
 +
|Y/Y
 +
|List of subscriptions requested
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== EventSubscripRequestItemType ===
 +
Location: //RequestEventSubscriptionType/EventSubscripRequestItem
 +
[[File:ComplexType EventSubscripRequestItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestItemId
 +
|string
 +
|1
 +
|Y/Y
 +
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|DataRequestSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|1
 +
|Y/Y
 +
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 +
|-
 +
|CanonicalEventCatalogUri
 +
|anyUri
 +
|1
 +
|Y/Y
 +
|Identifier of the canonical event catalogue.<br />'''Format:'''
 +
 
 +
* <nowiki>urn:de4a-eu:CanonicalEventCatalogueType</nowiki>::''catalogueID''
 +
 
 +
The complete set of values for ''catalogueID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|SubscriptionPeriod
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType]
 +
|0..1
 +
|Y/Y
 +
|Period of time for which the subscription will last.
 +
|}
 +
 
 +
=== TimePeriodType ===
 +
Location: //RequestEventSubscriptionType/EventSubscripRequestItem/SubscriptionPeriod
 +
[[File:ComplexType TimePeriodType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!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
 +
[[File:ComplexType ResponseEventSubscriptionType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y
 +
|Identifies the Data Evaluator who is making the request for subscription . This information is also used to route the responses from the Data Owner to the Data Evaluator.
 +
|-
 +
|DataOwner
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y
 +
|Identifies the Data Owner to whom the request for subscription is sent.
 +
|-
 +
|ResponseEventSubscriptionItem
 +
|ResponseEventSubscriptionItemType
 +
|1..n
 +
|Y
 +
|List of subscriptions requested
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== ResponseEventSubscriptionItemType ===
 +
Location: //ResponseEventSubscriptionType/ResponseEventSubscriptionItem
 +
[[File:ComplexType ResponseEventSubscriptionItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestItemId
 +
|string
 +
|1
 +
|Y
 +
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|CanonicalEventCatalogUri
 +
|anyUri
 +
|1
 +
|Y
 +
|Identifier of the canonical event catalogue.<br />'''Format:'''
 +
 
 +
* <nowiki>urn:de4a-eu:CanonicalEventCatalogueType</nowiki>::''catalogueID''
 +
 
 +
The complete set of values for ''catalogueID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|SubscriptionPeriod
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType]
 +
|1
 +
|Y
 +
|Confirmation of the period of time for which the subscription will last.
 +
|}
 +
 
 +
== EventNotificationType ==
 +
Location: //EventNotificationType
 +
[[File:ComplexType EventNotificationType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|NotificationId
 +
|String
 +
|1
 +
|Y
 +
|Event notification identifier (UUID format)
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y
 +
|Identifies the Data Evaluator to whom the event notification is sent.
 +
|-
 +
|DataOwner
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y
 +
|Identifies the Data Owner that sends the event notification message.
 +
|-
 +
|EventNotificationItem
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationItemType EventNotificationItemType]
 +
|1..n
 +
|Y
 +
|List of event notifications
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== EventNotificationItemType ===
 +
Location: //EventNotificationType/EventNotificationItem
 +
[[File:ComplexType EventNotificationItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|NotificationItemId
 +
|string
 +
|1
 +
|Y
 +
|Identifier of each item of the notification (UUID format)
 +
|-
 +
|EventId
 +
|string
 +
|1
 +
|Y
 +
|Identifier of the event that triggered the notification in the DO system.
 +
|-
 +
|EventSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|1
 +
|Y
 +
|Contains the identifying details of the company or representative to whom the event notification relates.
 +
|-
 +
|CanonicalEventCatalogUri
 +
|anyUri
 +
|1
 +
|Y
 +
|Identifier of the canonical event catalogue.<br />'''Format:'''
 +
 
 +
* <nowiki>urn:de4a-eu:CanonicalEventCatalogueType</nowiki>::''catalogueID''
 +
 
 +
The complete set of values for ''catalogueID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|EventDate
 +
|Datetime
 +
|1
 +
|Y
 +
|Date when the event occurred.
 +
|-
 +
|RelatedEventSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|0..n
 +
|Y
 +
|Contains the identification data of possible subjects also related to or afected by this event.
 +
|}
 +
 
 +
== RequestExtractMultiEvidenceLUType ==
 +
Location: //RequestExtractMultiEvidenceLUType
 +
[[File:ComplexType RequestExtractMultiEvidenceLUType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestId
 +
|String
 +
|1
 +
|Y
 +
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 +
|-
 +
|SpecificationId
 +
|String
 +
|1
 +
|Y
 +
|IEM version used
 +
|-
 +
|Timestamp
 +
|Date
 +
|1
 +
|Y
 +
|Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
 +
|-
 +
|ProcedureId
 +
|String
 +
|0..1
 +
|N
 +
|Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
 +
|-
 +
|DataEvaluator
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType 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
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 +
|1
 +
|Y
 +
|Identifies the Data Owner to whom the request for evidence is sent.
 +
|-
 +
|RequestEvidenceLUItem
 +
|RequestEvidenceLUItemType
 +
|1..n
 +
|Y
 +
|List of requested canonical evidence types
 +
|}
 +
 
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
 +
 
 +
=== RequestEvidenceLUItemType ===
 +
Location: //RequestExtractMultiEvidenceLUType/RequestEvidenceLUItem
 +
[[File:ComplexType RequestEvidenceLUItemType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|RequestItemId
 +
|String
 +
|1
 +
|Y
 +
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 +
 
 +
|-
 +
|DataRequestSubject
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 +
|1
 +
|Y
 +
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 +
|-
 +
|CanonicalEvidenceTypeId
 +
|String
 +
|1
 +
|Y
 +
|Identifier of the canonical evidence type.<br />'''Format:'''
 +
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
 +
 
 +
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
 +
|-
 +
|RequestGrounds
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
 +
|1
 +
|Y
 +
|Legal grounds justifying the request for evidence and supporting the applicant.
 +
|-
 +
|AdditionalParameter
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
 +
|0..n
 +
|N/Y
 +
|Contains each additional parameter necessary to request the evidence.
 +
|-
 +
|EventNotificationRef
 +
|String
 +
|1
 +
|Y
 +
|NotificationId of the event notification this Lookup request is based on.
 +
|}
 +
 
 +
== ResponseErrorType ==
 +
Location: //ResponseErrorType
 +
[[File:ComplexType ResponseErrorType.jpg|none|frame]]
 +
{| class="wikitable"
 +
!Name
 +
!Type
 +
!Cardinality
 +
!Mandatory Field / Label
 +
!Description
 +
|-
 +
|Ack
 +
|boolean
 +
|1
 +
|Y/Y
 +
|Value returned in case no error occurred.
 +
|-
 +
|Error
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
 +
|0..n
 +
|N/Y
 +
|Data type returned in case of error.
 
|}
 
|}
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd#L366 common-types.xsd]

Latest revision as of 12:49, 5 January 2023

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
ResponseItem ResponseItemType 1..n Y/Y Contains a list of available sources obtained.
Error ErrorType 1..n Y/Y Contains a list with the descriptions of the errors if one or more have occurred.

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 DE4A Logs and error messages it2
Text String 1 Y/Y Text defining the above code. See DE4A Logs and error messages it2

RequestExtractMultiEvidenceIMType

ComplexType RequestExtractMultiEvidenceIMType.jpg 
Location: //RequestExtractMultiEvidenceIMType
Name Type Cardinality Mandatory Field / Label Description
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
SpecificationId String 1 Y/Y IEM version used
Timestamp Date 1 Y/Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
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 List of requested canonical evidence types

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). Based on the schema "https://data.europe.eu/semanticassets/ns/cv/common/dataTypes-2.0.0#"
RedirectUrl String 0..1 N/Y URL of the web page of origin. It is only filled in by the Data Evaluator in the context of the USI pattern, so that the Data Owner knows where to return the User once the preview has been completed in the DO portal.

RequestEvidenceItemType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType
ComplexType RequestEvidenceItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y/Y Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to whom the evidence relates.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.
Format:
  • urn:de4a-eu:CanonicalEvidenceType::evidenceID

The complete set of values for evidenceID is available at codelists on the WP5 GitHub.

RequestGrounds RequestGroundsType 1 Y/Y Legal grounds justifying the request for evidence and supporting the applicant.
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 whom the evidence relates. Based on the schema "http://eidas.europa.eu/attributes/naturalperson".
DataSubjectCompany LegalPersonIdentifierType 1 Y/Y Contains the identifying details of the company to which the evidence or event relates. Based on the schema "http://eidas.europa.eu/attributes/legalperson".
DataSubjectRepresentative NaturalPersonIdentifierType 0..1 N/Y Contains the identifying details of the company representative to which the evidence or event relates. Based on the schema "http://eidas.europa.eu/attributes/naturalperson".

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 of the natural person.

Format: YYYY-MM-DD

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

Allowed values:

  • Male
  • Female
  • Unspecified
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 of the 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 Value Addex Tax registration number
TaxReference String 0..1 N/N Tax reference number
D-2012-17-EUIdentifier String 0..1 N/N 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 to the european law that allows a DE to request the corresponding evidence, identified by the European Legislation Identifier (ELI).
ExplicitRequest token 1 Y/Y Explicit consent made by the User to allow the DE to request the appropriate evidence through the DE4A system. Requirement imposed by article 14 of the SDG Regulation.

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 type
  • InputText → Input Text type
  • YesNo → Selector Yes/No type
Value String 1 Y/Y Value of the required parameter.

ResponseExtractMultiEvidenceType

ComplexType ResponseExtractMultiEvidenceType.jpg 
Location: //ResponseExtractMultiEvidenceType
Name Type Cardinality Mandatory Field / Label Description
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
Timestamp Date 1 Y/Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
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 List of requested canonical evidence types

Schema XSD

common-types.xsd

ResponseExtractEvidenceItemType

Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem
ComplexType ResponseExtractEvidenceItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y/Y Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to whom the evidence relates.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.
Format:
  • urn:de4a-eu:CanonicalEvidenceType::evidenceID

The complete set of values for evidenceID is available at codelists on the WP5 GitHub.

CanonicalEvidence CanonicalEvidenceType 1 Y/Y Evidence retrieved from the DO in its corresponding canonical format.
DomesticEvidence DomesticEvidenceType 0..n Y/Y Contains the data for each piece of national evidence retrieved from the DO in the original format in which they are issued.
Error ErrorType 1..n N/Y Contains a list with the descriptions of the errors if one or more have 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 the format of the evidence:
  • OriginalIssuing: Original format
  • MultinlingualFormIssuing: Multilingual format
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})*

EvidenceData base64Binary 1 Y/Y Contains the domestic evidence 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 the 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
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
SpecificationId String 1 Y/Y IEM version used.
Timestamp Date 1 Y/Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
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 List of requested canonical evidence types

Schema XSD

common-types.xsd

RequestExtractMultiEvidenceType

Location: //ResponseExtractMultiEvidenceUSIType/RequestEvidenceUSIItem
ComplexType RequestEvidenceUSIItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y/Y Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to whom the evidence relates.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.
Format:
  • urn:de4a-eu:CanonicalEvidenceType::evidenceID

The complete set of values for evidenceID is available at codelists on the WP5 GitHub.

RequestGrounds RequestGrounds 1 Y/Y Legal grounds justifying the request for evidence and supporting the applicant.
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
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
SpecificationId String 1 Y IEM version used
Timestamp Date 1 Y/Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
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:de4a-eu:CanonicalEvidenceType::evidenceID

The complete set of values for evidenceID is available at codelists on the WP5 GitHub.

RedirectURL anyURI 1 Y/Y Indicates the URL of the DO portal where to send the User to choose and preview the evidence.
Error ErrorType 0..n N/Y Contains the description of the error if one has occurred.

Schema XSD

common-types.xsd

RequestEventSubscriptionType

Location: //RequestEventSubscriptionType
ComplexType RequestEventSubscriptionType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestId String 1 Y/Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
SpecificationId String 1 Y/Y IEM version used
Timestamp Date 1 Y/Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
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 subscription. 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 subscription is sent.
EventSubscripRequestItem EventSubscripRequestItemType 1..n Y/Y List of subscriptions 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 Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
DataRequestSubject DataRequestSubjectCVType 1 Y/Y Contains the identifying details of the person, company or representative to whom the evidence relates.
CanonicalEventCatalogUri anyUri 1 Y/Y Identifier of the canonical event catalogue.
Format:
  • urn:de4a-eu:CanonicalEventCatalogueType::catalogueID

The complete set of values for catalogueID is available at codelists on the WP5 GitHub.

SubscriptionPeriod TimePeriodType 0..1 Y/Y Period of time for which the subscription will last.

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
RequestId String 1 Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
Timestamp Date 1 Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
DataEvaluator AgentType 1 Y Identifies the Data Evaluator who is making the request for subscription . 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 subscription is sent.
ResponseEventSubscriptionItem ResponseEventSubscriptionItemType 1..n Y List of subscriptions requested

Schema XSD

common-types.xsd

ResponseEventSubscriptionItemType

Location: //ResponseEventSubscriptionType/ResponseEventSubscriptionItem
ComplexType ResponseEventSubscriptionItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId string 1 Y Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
CanonicalEventCatalogUri anyUri 1 Y Identifier of the canonical event catalogue.
Format:
  • urn:de4a-eu:CanonicalEventCatalogueType::catalogueID

The complete set of values for catalogueID is available at codelists on the WP5 GitHub.

SubscriptionPeriod TimePeriodType 1 Y Confirmation of the period of time for which the subscription will last.

EventNotificationType

Location: //EventNotificationType
ComplexType EventNotificationType.jpg
Name Type Cardinality Mandatory Field / Label Description
NotificationId String 1 Y Event notification identifier (UUID format)
Timestamp Date 1 Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
DataEvaluator AgentType 1 Y Identifies the Data Evaluator to whom the event notification is sent.
DataOwner AgentType 1 Y Identifies the Data Owner that sends the event notification message.
EventNotificationItem EventNotificationItemType 1..n Y List of event notifications

Schema XSD

common-types.xsd

EventNotificationItemType

Location: //EventNotificationType/EventNotificationItem
ComplexType EventNotificationItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
NotificationItemId string 1 Y Identifier of each item of the notification (UUID format)
EventId string 1 Y Identifier of the event that triggered the notification in the DO system.
EventSubject DataRequestSubjectCVType 1 Y Contains the identifying details of the company or representative to whom the event notification relates.
CanonicalEventCatalogUri anyUri 1 Y Identifier of the canonical event catalogue.
Format:
  • urn:de4a-eu:CanonicalEventCatalogueType::catalogueID

The complete set of values for catalogueID is available at codelists on the WP5 GitHub.

EventDate Datetime 1 Y Date when the event occurred.
RelatedEventSubject DataRequestSubjectCVType 0..n Y Contains the identification data of possible subjects also related to or afected by this event.

RequestExtractMultiEvidenceLUType

Location: //RequestExtractMultiEvidenceLUType
ComplexType RequestExtractMultiEvidenceLUType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestId String 1 Y Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
SpecificationId String 1 Y IEM version used
Timestamp Date 1 Y Date and time of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
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 List of requested canonical evidence types

Schema XSD

common-types.xsd

RequestEvidenceLUItemType

Location: //RequestExtractMultiEvidenceLUType/RequestEvidenceLUItem
ComplexType RequestEvidenceLUItemType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestItemId String 1 Y Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
DataRequestSubject DataRequestSubjectCVType 1 Y Contains the identifying details of the person, company or representative to whom the evidence relates.
CanonicalEvidenceTypeId String 1 Y Identifier of the canonical evidence type.
Format:
  • urn:de4a-eu:CanonicalEvidenceType::evidenceID

The complete set of values for evidenceID is available at codelists on the WP5 GitHub.

RequestGrounds RequestGrounds 1 Y Legal grounds justifying the request for evidence and supporting the applicant.
AdditionalParameter AdditionalParameterType 0..n N/Y Contains each additional parameter necessary to request the evidence.
EventNotificationRef String 1 Y NotificationId of the event notification this Lookup request is based on.

ResponseErrorType

Location: //ResponseErrorType
ComplexType ResponseErrorType.jpg
Name Type Cardinality Mandatory Field / Label Description
Ack boolean 1 Y/Y Value returned in case no error occurred.
Error ErrorType 0..n N/Y Data type returned in case of error.

Schema XSD

common-types.xsd

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