Difference between revisions of "Data Dictionary"

From DE4A
Jump to navigation Jump to search
m (Quality review)
 
(39 intermediate revisions by 3 users not shown)
Line 7: Line 7:
  
 
== ResponseLookupRoutingInformationType ==
 
== ResponseLookupRoutingInformationType ==
 +
[[File:Element ResponseLookupRoutingInformation.jpg|frame|alt=|none]]
 
{| class="wikitable"
 
{| class="wikitable"
−
|+[[File:Element ResponseLookupRoutingInformation.jpg|left|frame]]
 
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|ResponseLookupRoutingInformation
 
−
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformationType]
 
−
|Not apply
 
−
|Y/Y
 
−
|Root element
 
 
|-
 
|-
 
|ResponseItem
 
|ResponseItem
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseItemType ResponseItemType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseItemType ResponseItemType]
−
|Cardinality 1..∞
+
|1..n
 
|Y/Y
 
|Y/Y
 
|Contains a list of available sources obtained.
 
|Contains a list of available sources obtained.
Line 29: Line 23:
 
|Error
 
|Error
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
−
|Cardinality 1..∞
+
|1..n
 
|Y/Y
 
|Y/Y
−
|Contains the response error.  
+
|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 ===
Line 41: Line 38:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 47: Line 44:
 
|ResponsePerCountry
 
|ResponsePerCountry
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponsePerCountryType ResponsePerCountryType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponsePerCountryType ResponsePerCountryType]
−
|Cardinality 1..∞
+
|1..n
 
|Y/Y
 
|Y/Y
 
|Contains the data for each source obtained.
 
|Contains the data for each source obtained.
Line 59: Line 56:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 65: Line 62:
 
|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  
Line 74: Line 71:
 
|Provision
 
|Provision
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ProvisionType ProvisionType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ProvisionType ProvisionType]
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
−
|
+
|Contains the data of each possible provision.
 
|}
 
|}
  
Line 85: Line 82:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 91: Line 88:
 
|AtuLevel
 
|AtuLevel
 
|String
 
|String
−
| Enumerated
+
| 1
−
|N
+
|N/Y
−
|Level of administration territorial unit.  
+
|Level of Administrative Territorial Unit.
−
 
+
'''Allowed values:'''
−
 
 
  
−
 
+
* nuts0: National level  
−
'''Allowed values:'''
+
* nuts1: Regional/Province level  
−
 
+
* nuts2: Regional/Province level  
−
nuts0: National level  
+
* nuts3: Regional/Province level  
−
 
+
* lau: Local level  
−
nuts1: Regional/Province level  
+
* edu: Educational level  
−
 
 
−
nuts2: Regional/Province level  
 
−
 
 
−
nuts3: Regional/Province level  
 
−
 
 
−
lau: Local level  
 
−
 
 
−
edu: Educational level  
 
 
|-
 
|-
 
|AtuCode
 
|AtuCode
 
|String
 
|String
−
|Not apply
+
|1
−
|N
+
|N/Y
−
| Code of the administrative territory unit.  
+
| Code of the Administrative Territorial Unit.
  
 +
'''Allowed values:'''
  
−
 
+
* "ISO 3166-1 alfa-2" for nuts0
−
 
+
* "Region" for nuts1-3
−
'''Allowed values:'''
+
* "Municipality" for lau
−
 
+
* "Educational Organization" for edu
−
ISO 3166-1 alfa-2 for nuts0  
 
−
 
 
−
Region for nuts1-3  
 
−
 
 
−
Municipality for lau  
 
−
 
 
−
Educational Organization for edu  
 
 
|-
 
|-
 
|AtuLatinName
 
|AtuLatinName
 
|String
 
|String
−
|Not apply
+
|1
−
|N
+
|N/Y
−
|Name of the administrative territorial unit.
+
|Name of the Administrative Territorial Unit.
 
|-
 
|-
 
|DataOwnerId
 
|DataOwnerId
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
−
|N
+
|N/Y
−
|Identifies DataOwner in format iso6523.<br />
+
|Identifies the Data Owner in iso6523 format. It defines Party Id for all participants. It must be unique.
−
It defines Party ID for all participants
+
'''Format:''' {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id} → iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15}
  
−
MUST be UNIQUE  
+
* '''{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.
  
−
'''Format:''' {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id}
+
Example of the Spanish Municipality of San Sebastian with LAU code 20069: '''ES990020069'''
  
−
iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15}
+
Example of the Dutch Province of Groningen with NUTS code NL11: '''NL990000011''' 
  
−
{PEPPOL ParticipantIdentifierScheme} à Must be a constant “iso6523-actorid-upis”
+
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
−
 
 
−
{Domain Scheme} à Identifies ICD value, must be 4 UNIQUE digits in PEPPOL
 
−
 
 
−
{Party Id} à Identifies DE4A Partner, consisting of:
 
−
 
 
−
2 letters country
 
−
 
 
−
2 digits entity type à 00 if entity is a DE4A partner, 88 if not
 
−
 
 
−
7 digits DE4A Partner
 
−
 
 
−
For regional or local administrations, the entity type is 99 and the 7 digit number is the NUTS/LAU code without country letters and starting with as many zeros 
 
−
 
 
−
on the left as necessary until 7 digits.  
 
  
−
Example Spanish Municipality of San Sebastian with LAU code 20069: ES990020069
+
For further information on the Domain Scheme values, see the [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
Example of Dutch Province of Groningen with NUTS code NL11: NL990000011
 
−
 
 
−
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
 
 
|-
 
|-
 
|DataOwnerPrefLabel
 
|DataOwnerPrefLabel
 
|String
 
|String
−
|Not apply
+
|1
−
|N
+
|N/Y
 
|Name of the issuing DO from which the evidence is obtained.
 
|Name of the issuing DO from which the evidence is obtained.
 
|-
 
|-
 
|ParameterSet
 
|ParameterSet
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ParameterSetType ParameterSetType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ParameterSetType ParameterSetType]
−
|Not apply
+
|0..n
−
|Y
+
|Y/Y
 
|Contains a list of necessary parameters for the requested evidence.
 
|Contains a list of necessary parameters for the requested evidence.
  
Line 193: Line 162:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 199: Line 168:
 
|Title
 
|Title
 
|String
 
|String
−
|Not apply
+
|1
−
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ParameterType ParameterType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ParameterType ParameterType]
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
 
|Contains the data for each necessary parameter of the requested evidence.
 
|Contains the data for each necessary parameter of the requested evidence.
 
|}
 
|}
  
 
=== ParameterType ===
 
=== ParameterType ===
−
  Location: //ResponseLookupRoutingInformation/ AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet  
+
  Location: //ResponseLookupRoutingInformation/AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet  
 
[[File:ComplexType ParameterType.jpg|none|frame]]
 
[[File:ComplexType ParameterType.jpg|none|frame]]
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 222: Line 191:
 
|Name
 
|Name
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
 
|Name of the parameter  
 
|Name of the parameter  
 
|-
 
|-
 
|Optional
 
|Optional
 
|Boolean
 
|Boolean
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Indicates if the parameter is optional of not  
+
|Indicates whether the parameter is optional or not
 
|}
 
|}
  
Line 239: Line 208:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 245: Line 214:
 
|Code
 
|Code
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Error code occurred. See [FIX TABLE/DOCUMENT ERRORS]
+
|Code of the error occurred. See [[DE4A Logs and error messages it2]]
 
|-
 
|-
 
|Text
 
|Text
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS]
+
|Text defining the above code. See [[DE4A Logs and error messages it2]]
 
|}
 
|}
  
Line 262: Line 231:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|RequestExtractMultiEvidenceIMType
 
−
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
−
|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 of creation of the message. Its value will remain unchanged as it passes through the intermediate components until it reaches its final destination.
−
are created.
 
 
|-
 
|-
 
|ProcedureId
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|1
−
|N
+
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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  
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEvidenceItemType RequestEvidenceItemType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEvidenceItemType RequestEvidenceItemType]
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
−
|Cardinality 1..∞
+
|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 ===
 
=== AgentType ===
Line 322: Line 287:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 328: Line 293:
 
|AgentUrn
 
|AgentUrn
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
−
|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 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.
  
−
'''{PEPPOL ParticipantIdentifierScheme}:''' Must be a constant “iso6523-actorid-upis”
+
Example of the Spanish Municipality of San Sebastian with LAU code 20069: '''ES990020069'''
  
−
'''{Domain Scheme}:''' Identifies ICD value, must be 4 UNIQUE digits in PEPPOL
+
Example of the Dutch Province of Groningen with NUTS code NL11: '''NL990000011'''
  
−
'''{Party Id}:''' Identifies DE4A Partner, consisting of:
+
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
−
 
 
−
2 letters country
 
−
 
 
−
2 digits entity type à 00 if entity is a DE4A partner, 88 if not
 
−
 
 
−
7 digits DE4A Partner 
 
−
 
 
−
For regional or local administrations, the entity type is 99 and the 7 digit number is the NUTS/LAU code without country 
 
−
 
 
−
letters and starting with as many zeros on the left as necessary until 7 digits.  
 
−
 
 
−
Example Spanish Municipality of San Sebastian with LAU code 20069: '''ES990020069''' 
 
−
 
 
−
Example of Dutch Province of Groningen with NUTS code NL11: '''NL990000011''' 
 
  
−
https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
+
For further information on the Domain Scheme values, see the [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
  
 
|-
 
|-
 
|AgentName
 
|AgentName
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/N
−
|Name of the agent Data Owner.  
+
|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
 
|RedirectUrl
 
|String
 
|String
−
|Not apply
+
|0..1
−
|Y
+
|N/Y
−
|Redirect URL to Data Owner.  
+
|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.
 
|}
 
|}
  
Line 377: Line 333:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 383: Line 339:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Evidence request unique id
+
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
  
 
|-
 
|-
 
|DataRequestSubject
 
|DataRequestSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the identifying details of the person, company or representative to obtain the evidence.  
+
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 
|-
 
|-
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Identifier of the canonical evidence type.<br />
+
|Identifier of the canonical evidence type.<br />'''Format:'''
−
'''Format:'''  
+
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
  
−
<nowiki>urn:dea4-eu:CanonicalEvidenceType</nowiki>::<canonical-evidence-type-idtoken>
+
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
<br />
 
−
'''Allowed values for <canonical-evidence-type-idtoken>:'''
 
−
 
 
−
* HigherEducationDiploma
 
−
* DomicileRegistrationEvidence
 
−
* BirthCertificate
 
−
* MarriageCertificate
 
−
* CompanyRegistration
 
 
|-
 
|-
 
|RequestGrounds
 
|RequestGrounds
−
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGroundsType RequestGroundsType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request grounds to request evidence.  
+
|Legal grounds justifying the request for evidence and supporting the applicant.
 
|-
 
|-
 
|AdditionalParameter  
 
|AdditionalParameter  
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
−
|Cardinality 1..∞
+
|0..n
−
|N
+
|N/Y
 
|Contains each additional parameter necessary to request the evidence.  
 
|Contains each additional parameter necessary to request the evidence.  
 
|}
 
|}
Line 431: Line 378:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 437: Line 384:
 
|DataSubjectPerson
 
|DataSubjectPerson
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#NaturalPersonIdentifierType NaturalPersonIdentifierType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#NaturalPersonIdentifierType NaturalPersonIdentifierType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the identifying details of the person to obtain the evidence.  
+
|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  
 
|DataSubjectCompany  
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#LegalPersonIdentifierType LegalPersonIdentifierType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#LegalPersonIdentifierType LegalPersonIdentifierType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the identifying details of the company to obtain the evidence.  
+
|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  
 
|DataSubjectRepresentative  
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#NaturalPersonIdentifierType NaturalPersonIdentifierType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#NaturalPersonIdentifierType NaturalPersonIdentifierType]
−
|Not apply
+
|0..1
−
|N
+
|N/Y
−
|Contains the identifying details of the representative to obtain the evidence.  
+
|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>".
 
|}
 
|}
  
Line 461: Line 408:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 467: Line 414:
 
|PersonIdentifier
 
|PersonIdentifier
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/N
 
|Unique identifier for the natural person as defined by the eIDAS Regulation.  
 
|Unique identifier for the natural person as defined by the eIDAS Regulation.  
  
Line 474: Line 421:
 
|FirstName
 
|FirstName
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/N
 
|Current given names of the natural person.  
 
|Current given names of the natural person.  
 
|-
 
|-
 
|FamilyName
 
|FamilyName
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/N
 
|Current family name of the natural person.  
 
|Current family name of the natural person.  
 
|-
 
|-
 
|DateOfBirth
 
|DateOfBirth
 
|Date
 
|Date
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Date of birth for the natural person.  
+
|Date of birth of the natural person.  
  
−
Format: '''YYYY-MM-DD'''  
+
Format: '''YYYY-MM-DD'''
 
|-
 
|-
 
|Gender
 
|Gender
 
|String
 
|String
−
|Enumetared
+
|0..1
−
|Y
+
|N/Y
 
|Gender of the natural person.  
 
|Gender of the natural person.  
  
Line 506: Line 453:
 
|BitrhName
 
|BitrhName
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
 
|First name(s) and family name(s) of the natural person at birth.  
 
|First name(s) and family name(s) of the natural person at birth.  
 
|-
 
|-
 
|PlaceOfBirth
 
|PlaceOfBirth
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|Place of birth for a natural person.  
+
|Place of birth of the natural person.
 
|-
 
|-
 
|CurrentAddress
 
|CurrentAddress
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
 
|Current address of the natural person as a '''base64 encoded string'''.  
 
|Current address of the natural person as a '''base64 encoded string'''.  
 
|}
 
|}
Line 529: Line 476:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 535: Line 482:
 
|LegalPersonIdentifier
 
|LegalPersonIdentifier
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/N
 
|Unique identifier for the legal person as defined by the eIDAS Regulation.  
 
|Unique identifier for the legal person as defined by the eIDAS Regulation.  
  
Line 542: Line 489:
 
|LegalName
 
|LegalName
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/N
 
|Current legal name for the legal person or organisation.  
 
|Current legal name for the legal person or organisation.  
 
|-
 
|-
 
|LegalAddress
 
|LegalAddress
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
 
|The address the legal person has registered with the MS authority or operating address if not registered.  
 
|The address the legal person has registered with the MS authority or operating address if not registered.  
  
Line 556: Line 503:
 
|VATRegistration
 
|VATRegistration
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|VAT - VAT registration number.
+
|Value Addex Tax registration number
 
|-
 
|-
 
|TaxReference
 
|TaxReference
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|TAX-Ref - tax reference number.
+
|Tax reference number
 
|-
 
|-
 
|D-2012-17-EUIdentifier
 
|D-2012-17-EUIdentifier
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|D-2012/17/EU - the identifier used under directive 2012/17/EU  
+
|The identifier used under directive 2012/17/EU
 
|-
 
|-
 
|LEI
 
|LEI
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|Legal Entity Identifier.
+
|Legal Entity Identifier
 
|-
 
|-
 
|EORI
 
|EORI
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|Economic Operator Registration and Identification.
+
|Economic Operator Registration and Identification
 
|-
 
|-
 
|SEED
 
|SEED
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|System for Exchange of Excise Data.
+
|System for Exchange of Excise Data
 
|-
 
|-
 
|SIC
 
|SIC
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|Standard Industrial Classification.
+
|Standard Industrial Classification
 
|}
 
|}
  
Line 603: Line 550:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 609: Line 556:
 
|LawELIPermanentLink
 
|LawELIPermanentLink
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Permanent link allowing access to the system.  
+
|Permanent link to the european law that allows a DE to request the corresponding evidence, identified by the European Legislation Identifier (ELI).
  
 
|-
 
|-
 
|ExplicitRequest  
 
|ExplicitRequest  
 
|token
 
|token
−
|Enumerated
+
|1
−
|Y
+
|Y/Y
−
|Consent allowing access to the system.  
+
|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.
−
 
 
−
Allowed values:
 
−
 
 
−
'''SDGR14'''
 
 
|}
 
|}
  
Line 630: Line 573:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 636: Line 579:
 
|Label
 
|Label
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
 
|Label identifying the required parameter.  
 
|Label identifying the required parameter.  
  
Line 643: Line 586:
 
|Type
 
|Type
 
|String
 
|String
−
|Enumerated
+
|1
−
|Y
+
|Y/Y
 
|Type of the required parameter.  
 
|Type of the required parameter.  
  
−
 
+
'''Allowed values:'''
−
 
+
* Date → Date type
−
'''Allowed values:'''  
+
* InputText → Input Text type
−
 
+
* YesNo → Selector Yes/No type
−
* Date à Date tye
 
−
* InputText à Input Text type  
 
−
* YesNo à Selector Yes/No type  
 
 
|-
 
|-
 
|Value
 
|Value
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
 
|Value of the required parameter.  
 
|Value of the required parameter.  
 
|}
 
|}
Line 668: Line 608:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|RequestExtractMultiEvidenceIMType
 
−
|ResponseExtractMultiEvidenceType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
−
|Y
+
|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.
+
|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
 
|DataEvaluator
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|ResponseExtractEvidenceItemType
 
|ResponseExtractEvidenceItemType
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
−
|Evidence requested  
+
|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 ===
 
=== ResponseExtractEvidenceItemType ===
Line 715: Line 652:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 721: Line 658:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Evidence request unique id
+
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
  
 
|-
 
|-
 
|DataRequestSubject
 
|DataRequestSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the identifying details of the person, company or representative to obtain the evidence.
+
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 
|-
 
|-
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Identifier of the canonical evidence type.  
+
|Identifier of the canonical evidence type.<br />'''Format:'''
 +
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
  
−
'''Format:''' 
+
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
<nowiki>urn:dea4-eu:CanonicalEvidenceType</nowiki>::<canonical-evidence-type-idtoken> 
 
−
 
 
−
'''Allowed values for <canonical-evidence-type-idtoken>:'''
 
−
 
 
−
* HigherEducationDiploma
 
−
* DomicileRegistrationEvidence
 
−
* BirthCertificate
 
−
* MarriageCertificate
 
−
* CompanyRegistration
 
 
|-
 
|-
 
|CanonicalEvidence
 
|CanonicalEvidence
 
|CanonicalEvidenceType
 
|CanonicalEvidenceType
−
|lax
+
|1
−
|Y
+
|Y/Y
−
|Canonical Evidence obtained.  
+
|Evidence retrieved from the DO in its corresponding canonical format.
 
|-
 
|-
 
|DomesticEvidence
 
|DomesticEvidence
 
|DomesticEvidenceType
 
|DomesticEvidenceType
−
|Cardinality 1..∞
+
|0..n
−
|Y
+
|Y/Y
−
|Contains the data of each domestic evidences obtained.  
+
|Contains the data for each piece of national evidence retrieved from the DO in the original format in which they are issued.
 
|-
 
|-
 
|Error
 
|Error
 
|ErrorType
 
|ErrorType
−
|Cardinality 1..∞
+
|1..n
−
|N
+
|N/Y
−
|Contains the data for each error that occurred.  
+
|Contains a list with the descriptions of the errors if one or more have occurred.
 
|}
 
|}
  
Line 778: Line 706:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 784: Line 712:
 
|IssuingType
 
|IssuingType
 
|Token
 
|Token
−
|Enumerated
+
|1
−
|Y
+
|Y/Y
−
|Indicates what type of evidence it is:  
+
|Indicates the format of the evidence:
−
 
 
−
'''OriginalIssuing''' à
 
−
 
 
−
Original Evidence
 
  
−
'''MultinlingualFormIssuing''' à
+
* '''OriginalIssuing:''' Original format
−
 
+
* '''MultinlingualFormIssuing:''' Multilingual format
−
Multilingual evidence
 
  
 
|-
 
|-
 
|MimeType
 
|MimeType
 
|normalizedString  
 
|normalizedString  
−
|Enumerated
+
|1
−
|Y
+
|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
 
|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
 
|DataLanguage
 
|language
 
|language
−
|Not apply
+
|1
−
|N
+
|Y/N
−
|Contains the language of the canonical evidence.<br />'''Values conform to <nowiki>RFC 3066</nowiki>, allowed values:'''<br />Conformity to ISO 639
+
|Contains the language of the canonical evidence.
−
Conformity to ISO 3166
+
'''Values conform to <nowiki>RFC 3066</nowiki>, allowed values:'''
  
−
Languages registered by the Internet Assigned Numbers Authority (IANA)  
+
* 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})*  
 
Expression pattern: [a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*  
Line 816: Line 741:
 
|EvidenceData
 
|EvidenceData
 
|base64Binary
 
|base64Binary
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the domestic that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64.  
+
|Contains the domestic evidence that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64.
 
|-
 
|-
 
|AdditionalInfo
 
|AdditionalInfo
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TextType TextType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TextType TextType]
−
|Not apply
+
|0..1
−
|N
+
|N/N
−
|Contains additional information about domestic evidence.  
+
|Contains additional information about the domestic evidence.
 
|}
 
|}
  
Line 832: Line 757:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 838: Line 763:
 
|languageID
 
|languageID
 
|language
 
|language
−
|Attribute
+
|0..1
−
|N
+
|N/Y
 
|The identifier of the language used in the content.  
 
|The identifier of the language used in the content.  
  
Line 845: Line 770:
 
|languageLocaleID
 
|languageLocaleID
 
|normalizedString
 
|normalizedString
−
|Attribute
+
|0..1
−
|N
+
|N/Y
 
|The identification of the locale of the language.  
 
|The identification of the locale of the language.  
 
|}
 
|}
Line 856: Line 781:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|RequestExtractMultiEvidenceUSIType
 
−
|RequestExtractMultiEvidenceType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Version used and it will define the message structure.
+
|IEM version used.
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
−
|Y
+
|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.
+
|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
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|RequestEvidenceUSIItemType
 
|RequestEvidenceUSIItemType
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
−
|Evidence requested
+
|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 ===
 
=== RequestExtractMultiEvidenceType ===
Line 915: Line 837:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 921: Line 843:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Evidence request unique id
+
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
  
 
|-
 
|-
 
|DataRequestSubject
 
|DataRequestSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the identifying details of the person, company or representative to obtain the evidence.
+
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 
|-
 
|-
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Identifier of the canonical evidence type.<br />
+
|Identifier of the canonical evidence type.<br />'''Format:'''
−
'''Format:'''  
+
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
  
−
<nowiki>urn:dea4-eu:CanonicalEvidenceType</nowiki>::<canonical-evidence-type-idtoken>
+
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
<br />
 
−
'''Allowed values for <canonical-evidence-type-idtoken>:'''
 
−
 
 
−
* HigherEducationDiploma
 
−
* DomicileRegistrationEvidence
 
−
* BirthCertificate
 
−
* MarriageCertificate
 
−
* CompanyRegistration
 
 
|-
 
|-
 
|RequestGrounds
 
|RequestGrounds
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request grounds to request evidence.
+
|Legal grounds justifying the request for evidence and supporting the applicant.
 
|-
 
|-
 
|AdditionalParameter
 
|AdditionalParameter
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
−
|Cardinality 1..∞
+
|0..n
−
|N
+
|N/Y
 
|Contains each additional parameter necessary to request the evidence.
 
|Contains each additional parameter necessary to request the evidence.
 
|-
 
|-
 
|DataEvaluatorURL
 
|DataEvaluatorURL
 
|anyUri
 
|anyUri
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Indicates the redirection url to return to the user.
+
|Indicates the redirection URL to return the User to the e-procedure portal of the Data Evaluator.
 
|}
 
|}
  
Line 975: Line 888:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|RedirectUserType
 
−
|RedirectUserType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
−
|Y
+
|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.
+
|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
 
|DataEvaluator
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Identifier of the canonical evidence type.  
+
|Identifier of the canonical evidence type.<br />'''Format:'''
−
 
+
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
−
'''Format:'''
 
−
 
 
−
<nowiki>urn:dea4-eu:CanonicalEvidenceType</nowiki>::<canonical-evidence-type-idtoken> 
 
−
 
 
−
'''Allowed values for <canonical-evidence-type-idtoken>:'''  
 
  
−
* HigherEducationDiploma
+
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
* DomicileRegistrationEvidence
 
−
* BirthCertificate
 
−
* MarriageCertificate
 
−
* CompanyRegistration
 
 
|-
 
|-
 
|RedirectURL
 
|RedirectURL
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Indicates the redirection url to return to the user.
+
|Indicates the URL of the DO portal where to send the User to choose and preview the evidence.
 
|-
 
|-
 
|Error
 
|Error
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
−
|Cardinality 1..∞
+
|0..n
−
|Y
+
|N/Y
−
|Contains the response error.
+
|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 ==
 
== RequestEventSubscriptionType ==
Line 1,052: Line 953:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|RequestEventSubscriptionType
 
−
|RequestEventSubscriptionType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
−
|Y
+
|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.
+
|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
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|0..1
−
|N
+
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|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 subscription. This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for subscription is sent.
 
|-
 
|-
 
|EventSubscripRequestItem
 
|EventSubscripRequestItem
 
|EventSubscripRequestItemType
 
|EventSubscripRequestItemType
−
|Cardinality 1..∞
+
|1..n
−
|Y
+
|Y/Y
−
|Evidence requested
+
|List of subscriptions requested
 
|}
 
|}
 +
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
  
 
=== EventSubscripRequestItemType ===
 
=== EventSubscripRequestItemType ===
Line 1,111: Line 1,009:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,117: Line 1,015:
 
|RequestItemId
 
|RequestItemId
 
|string
 
|string
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Evidence request unique id
+
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|DataRequestSubject
 
|DataRequestSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Contains the identifying details of the person, company or representative to obtain the evidence.
+
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 
|-
 
|-
 
|CanonicalEventCatalogUri
 
|CanonicalEventCatalogUri
 
|anyUri
 
|anyUri
−
|Not apply
+
|1
−
|Y
+
|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
 
|SubscriptionPeriod
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType]
−
|Not apply
+
|0..1
−
|Y
+
|Y/Y
−
|Period dates of the subscription
+
|Period of time for which the subscription will last.
 
|}
 
|}
  
Line 1,146: Line 1,048:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,152: Line 1,054:
 
|StartDate
 
|StartDate
 
|dateTime
 
|dateTime
−
|Not apply
+
|1
−
|Y
+
|Y/Y
−
|Subscription Start Date
+
|Subscription start date
 
|-
 
|-
 
|EndDate
 
|EndDate
 
|dateTime
 
|dateTime
−
|Not apply
+
|0..1
−
|N
+
|N/Y
−
|Subscription End Date
+
|Subscription end date
 
|}
 
|}
  
Line 1,169: Line 1,071:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|ResponseEventSubscriptionType
 
−
|ResponseEventSubscriptionType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|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.
+
|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
 
|DataEvaluator
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|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 subscription . This information is also used to route the responses from the Data Owner to the Data Evaluator.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner to whom the request for subscription is sent.
 
|-
 
|-
 
|ResponseEventSubscriptionItem
 
|ResponseEventSubscriptionItem
 
|ResponseEventSubscriptionItemType
 
|ResponseEventSubscriptionItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y
 
|Y
−
|Evidence requested
+
|List of subscriptions requested
 
|}
 
|}
 +
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
  
 
=== ResponseEventSubscriptionItemType ===
 
=== ResponseEventSubscriptionItemType ===
Line 1,216: Line 1,115:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,222: Line 1,121:
 
|RequestItemId
 
|RequestItemId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Evidence request unique id
+
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|CanonicalEventCatalogUri
 
|CanonicalEventCatalogUri
 
|anyUri
 
|anyUri
−
|Not apply
+
|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
 
|SubscriptionPeriod
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Period dates of the subscription
+
|Confirmation of the period of time for which the subscription will last.
 
|}
 
|}
  
Line 1,245: Line 1,148:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|EventNotificationType
 
−
|EventNotificationType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|NotificationId
 
|NotificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Request notification identifier
+
|Event notification identifier (UUID format)
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|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.
+
|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
 
|DataEvaluator
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Identifier will be used to address the evidence back from the DataOwner.
+
|Identifies the Data Evaluator to whom the event notification is sent.
 
|-
 
|-
 
|DataOwner
 
|DataOwner
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Indentifier indicates the component responsible of issuing the evidence.
+
|Identifies the Data Owner that sends the event notification message.
 
|-
 
|-
 
|EventNotificationItem
 
|EventNotificationItem
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationItemType EventNotificationItemType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationItemType EventNotificationItemType]
−
|Cardinality 1..∞
+
|1..n
 
|Y
 
|Y
−
|Evidence requested
+
|List of event notifications
 
|}
 
|}
 +
 +
=== Schema XSD ===
 +
[https://github.com/de4a-wp5/xml-schemas/blob/master/XSD/de4a/common-types.xsd common-types.xsd]
  
 
=== EventNotificationItemType ===
 
=== EventNotificationItemType ===
Line 1,292: Line 1,192:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,298: Line 1,198:
 
|NotificationItemId
 
|NotificationItemId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Notification unique id
+
|Identifier of each item of the notification (UUID format)
 
|-
 
|-
 
|EventId
 
|EventId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Event unique id
+
|Identifier of the event that triggered the notification in the DO system.
 
|-
 
|-
 
|EventSubject
 
|EventSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Contains the identifying details of the person, company or representative to obtain the evidence.
+
|Contains the identifying details of the company or representative to whom the event notification relates.
 
|-
 
|-
 
|CanonicalEventCatalogUri
 
|CanonicalEventCatalogUri
 
|anyUri
 
|anyUri
−
|Not apply
+
|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.
 
|-
 
|-
 
|EventDate
 
|EventDate
 
|Datetime
 
|Datetime
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Date of the event notification
+
|Date when the event occurred.
 
|-
 
|-
 
|RelatedEventSubject
 
|RelatedEventSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Cardinality 1..∞
+
|0..n
 
|Y
 
|Y
−
|
+
|Contains the identification data of possible subjects also related to or afected by this event.
 
|}
 
|}
  
Line 1,339: Line 1,243:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
−
|-
 
−
|RequestExtractMultiEvidenceLUType
 
−
|RequestExtractMultiEvidenceLUType
 
−
|Not apply
 
−
|Y
 
−
|Root element
 
 
|-
 
|-
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Request message identifier
+
|Request identifier (UUID format). It is going to be the same during all interactions of this message exchange.
 
|-
 
|-
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Version used and it will define the message structure.
+
|IEM version used
 
|-
 
|-
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|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.
+
|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
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|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
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType]
−
|Not apply
+
|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
 
|RequestEvidenceLUItemType
 
|RequestEvidenceLUItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y
 
|Y
−
|Evidence requested
+
|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 ===
 
=== RequestEvidenceLUItemType ===
Line 1,398: Line 1,299:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,404: Line 1,305:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Evidence request unique id
+
|Identifier of each item of the request (UUID format). It is going to be the same during all interactions of this message exchange.
  
 
|-
 
|-
 
|DataRequestSubject
 
|DataRequestSubject
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Contains the identifying details of the person, company or representative to obtain the evidence.
+
|Contains the identifying details of the person, company or representative to whom the evidence relates.
 
|-
 
|-
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Identifier of the canonical evidence type.<br />
+
|Identifier of the canonical evidence type.<br />'''Format:'''
−
'''Format:'''  
+
* <nowiki>urn:de4a-eu:CanonicalEvidenceType</nowiki>::''evidenceID''
  
−
<nowiki>urn:dea4-eu:CanonicalEvidenceType</nowiki>::<canonical-evidence-type-idtoken>
+
The complete set of values for ''evidenceID'' is available at [https://github.com/de4a-wp5/de4a-codelists codelists] on the WP5 GitHub.
−
 
 
−
<br />
 
−
'''Allowed values for <canonical-evidence-type-idtoken>:'''
 
−
* HigherEducationDiploma
 
−
* DomicileRegistrationEvidence
 
−
* BirthCertificate
 
−
* MarriageCertificate
 
−
* CompanyRegistration
 
 
|-
 
|-
 
|RequestGrounds
 
|RequestGrounds
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds]
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Request grounds to request evidence.
+
|Legal grounds justifying the request for evidence and supporting the applicant.
 
|-
 
|-
 
|AdditionalParameter
 
|AdditionalParameter
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AdditionalParameterType AdditionalParameterType]
−
|Cardinality 1..∞
+
|0..n
−
|N
+
|N/Y
 
|Contains each additional parameter necessary to request the evidence.
 
|Contains each additional parameter necessary to request the evidence.
 
|-
 
|-
 
|EventNotificationRef
 
|EventNotificationRef
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
−
|Reference of the notification event
+
|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’