|
|
| Line 108: |
Line 108: |
| | '''Allowed values:''' | | '''Allowed values:''' |
| | | | |
| − | * ISO 3166-1 alfa-2 for nuts0 | + | * "ISO 3166-1 alfa-2" for nuts0 |
| − | * Region for nuts1-3 | + | * "Region" for nuts1-3 |
| − | * Municipality for lau | + | * "Municipality" for lau |
| − | * Educational Organization for edu | + | * "Educational Organization" for edu |
| | |- | | |- |
| | |AtuLatinName | | |AtuLatinName |
Revision as of 18:12, 4 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
| 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
| 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
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 request.
|
| SpecificationId
|
String
|
1
|
Y/Y
|
IEM version used
|
| Timestamp
|
Date
|
1
|
Y/Y
|
Date and time when the message is created.
|
| ProcedureId
|
String
|
1
|
N/Y
|
Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
|
| DataEvaluator
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
|
| DataOwner
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Owner to whom the request for evidence is sent.
|
| RequestEvidenceIMItem
|
RequestEvidenceItemType
|
1..n
|
Y/Y
|
List of requested canonical evidence types
|
Schema XSD
common-types.xsd
AgentType
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
| 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 request.
|
| 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
| 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
| 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:
|
| 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
| 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
| 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.
|
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 request.
|
| Timestamp
|
Date
|
1
|
Y/Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| DataEvaluator
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
|
| DataOwner
|
AgentType
|
1
|
N/Y
|
Identifies the Data Owner to whom the request for evidence is sent.
|
| ResponseExtractEvidenceItem
|
ResponseExtractEvidenceItemType
|
1..n
|
Y/Y
|
List of requested canonical evidence types
|
Schema XSD
common-types.xsd
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem
| 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 request.
|
| 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
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.
|
Location: //ResponseExtractMultiEvidenceUSIType
| 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 request.
|
| SpecificationId
|
String
|
1
|
Y/Y
|
IEM version used.
|
| Timestamp
|
Date
|
1
|
Y/Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| ProcedureId
|
String
|
0..1
|
N/Y
|
Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
|
| DataEvaluator
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
|
| DataOwner
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Owner to whom the request for evidence is sent.
|
| RequestEvidenceUSIItem
|
RequestEvidenceUSIItemType
|
1..n
|
Y/Y
|
List of requested canonical evidence types
|
Schema XSD
common-types.xsd
Location: //ResponseExtractMultiEvidenceUSIType/RequestEvidenceUSIItem
| 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 request.
|
| 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
| 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 request.
|
| SpecificationId
|
String
|
1
|
Y
|
IEM version used
|
| Timestamp
|
Date
|
1
|
Y/Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| DataEvaluator
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
|
| DataOwner
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Owner to whom the request for evidence is sent.
|
| CanonicalEvidenceTypeId
|
String
|
1
|
Y/Y
|
Identifier of the canonical evidence type.
Format:
- urn: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
| 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 request.
|
| SpecificationId
|
String
|
1
|
Y/Y
|
IEM version used
|
| Timestamp
|
Date
|
1
|
Y/Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| ProcedureId
|
String
|
0..1
|
N/Y
|
Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
|
| DataEvaluator
|
AgentType
|
1
|
Y/Y
|
Identifies the Data Evaluator who is making the request for 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
| 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 request.
|
| 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
| 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
| 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 request.
|
| Timestamp
|
Date
|
1
|
Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| DataEvaluator
|
AgentType
|
1
|
Y
|
Identifies the Data Evaluator who is making the request for 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
| 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 request.
|
| 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
| Name
|
Type
|
Cardinality
|
Mandatory Field / Label
|
Description
|
| NotificationId
|
String
|
1
|
Y
|
Event notification identifier
|
| Timestamp
|
Date
|
1
|
Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| DataEvaluator
|
AgentType
|
1
|
Y
|
Identifies the Data Evaluator 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
| Name
|
Type
|
Cardinality
|
Mandatory Field / Label
|
Description
|
| NotificationItemId
|
string
|
1
|
Y
|
Unique notification ID
|
| 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.
|
Location: //RequestExtractMultiEvidenceLUType
| 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 request.
|
| SpecificationId
|
String
|
1
|
Y
|
IEM version used
|
| Timestamp
|
Date
|
1
|
Y
|
Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
|
| ProcedureId
|
String
|
0..1
|
N
|
Metadata about the procedure or public service the justifies the use of the DE4A OOTS.
|
| DataEvaluator
|
AgentType
|
1
|
Y
|
Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator.
|
| DataOwner
|
AgentType
|
1
|
Y
|
Identifies the Data Owner to whom the request for evidence is sent.
|
| RequestEvidenceLUItem
|
RequestEvidenceLUItemType
|
1..n
|
Y
|
List of requested canonical evidence types
|
Schema XSD
common-types.xsd
RequestEvidenceLUItemType
Location: //RequestExtractMultiEvidenceLUType/RequestEvidenceLUItem
| 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 request.
|
| 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
| 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
