Difference between revisions of "Data Dictionary"
Jump to navigation
Jump to search
Hugo.berdon (talk | contribs) |
Hugo.berdon (talk | contribs) |
||
| Line 860: | Line 860: | ||
|RequestExtractMultiEvidenceType | |RequestExtractMultiEvidenceType | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Root element | |Root element | ||
|- | |- | ||
| Line 866: | Line 866: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Request message identifier | |Request message identifier | ||
|- | |- | ||
| Line 872: | Line 872: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Version used and it will define the message structure. | |Version used and it will define the message structure. | ||
|- | |- | ||
| Line 878: | Line 878: | ||
|Date | |Date | ||
|Not apply | |Not apply | ||
| − | |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 when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. | ||
|- | |- | ||
| Line 884: | Line 884: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |N | + | |N/Y |
|Metadata about a procedure or public service. | |Metadata about a procedure or public service. | ||
|- | |- | ||
| Line 890: | Line 890: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Identifier will be used to address the evidence back from the DataOwner. | |Identifier will be used to address the evidence back from the DataOwner. | ||
|- | |- | ||
| Line 896: | Line 896: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Indentifier indicates the component responsible of issuing the evidence. | |Indentifier indicates the component responsible of issuing the evidence. | ||
|- | |- | ||
| Line 902: | Line 902: | ||
|RequestEvidenceUSIItemType | |RequestEvidenceUSIItemType | ||
|Cardinality 1..∞ | |Cardinality 1..∞ | ||
| − | |Y | + | |Y/Y |
|Evidence requested | |Evidence requested | ||
|} | |} | ||
| Line 922: | Line 922: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Evidence request unique id | |Evidence request unique id | ||
| Line 929: | Line 929: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType] | ||
|Not apply | |Not apply | ||
| − | |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 obtain the evidence. | ||
|- | |- | ||
| Line 935: | Line 935: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Identifier of the canonical evidence type. | |Identifier of the canonical evidence type. | ||
'''Format:''' | '''Format:''' | ||
| Line 951: | Line 951: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGrounds RequestGrounds] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Request grounds to request evidence. | |Request grounds to request evidence. | ||
|- | |- | ||
| Line 963: | Line 963: | ||
|anyUri | |anyUri | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Indicates the redirection url to return to the user. | |Indicates the redirection url to return to the user. | ||
|} | |} | ||
| Line 980: | Line 980: | ||
|RedirectUserType | |RedirectUserType | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Root element | |Root element | ||
|- | |- | ||
| Line 986: | Line 986: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Request message identifier | |Request message identifier | ||
|- | |- | ||
| Line 998: | Line 998: | ||
|Date | |Date | ||
|Not apply | |Not apply | ||
| − | |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 when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. | ||
|- | |- | ||
| Line 1,004: | Line 1,004: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Identifier will be used to address the evidence back from the DataOwner. | |Identifier will be used to address the evidence back from the DataOwner. | ||
|- | |- | ||
| Line 1,010: | Line 1,010: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Indentifier indicates the component responsible of issuing the evidence. | |Indentifier indicates the component responsible of issuing the evidence. | ||
|- | |- | ||
| Line 1,016: | Line 1,016: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Identifier of the canonical evidence type. | |Identifier of the canonical evidence type. | ||
| Line 1,034: | Line 1,034: | ||
|anyURI | |anyURI | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Indicates the redirection url to return to the user. | |Indicates the redirection url to return to the user. | ||
|- | |- | ||
| Line 1,040: | Line 1,040: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType] | ||
|Cardinality 1..∞ | |Cardinality 1..∞ | ||
| − | |Y | + | |N/Y |
|Contains the response error. | |Contains the response error. | ||
|} | |} | ||
| Line 1,060: | Line 1,060: | ||
|RequestEventSubscriptionType | |RequestEventSubscriptionType | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Root element | |Root element | ||
|- | |- | ||
| Line 1,066: | Line 1,066: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Request message identifier | |Request message identifier | ||
|- | |- | ||
| Line 1,072: | Line 1,072: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Version used and it will define the message structure. | |Version used and it will define the message structure. | ||
|- | |- | ||
| Line 1,078: | Line 1,078: | ||
|Date | |Date | ||
|Not apply | |Not apply | ||
| − | |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 when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. | ||
|- | |- | ||
| Line 1,084: | Line 1,084: | ||
|String | |String | ||
|Not apply | |Not apply | ||
| − | |N | + | |N/Y |
|Metadata about a procedure or public service. | |Metadata about a procedure or public service. | ||
|- | |- | ||
| Line 1,090: | Line 1,090: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Identifier will be used to address the evidence back from the DataOwner. | |Identifier will be used to address the evidence back from the DataOwner. | ||
|- | |- | ||
| Line 1,096: | Line 1,096: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#AgentType AgentType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Indentifier indicates the component responsible of issuing the evidence. | |Indentifier indicates the component responsible of issuing the evidence. | ||
|- | |- | ||
| Line 1,102: | Line 1,102: | ||
|EventSubscripRequestItemType | |EventSubscripRequestItemType | ||
|Cardinality 1..∞ | |Cardinality 1..∞ | ||
| − | |Y | + | |Y/Y |
|Evidence requested | |Evidence requested | ||
|} | |} | ||
| Line 1,122: | Line 1,122: | ||
|string | |string | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Evidence request unique id | |Evidence request unique id | ||
|- | |- | ||
| Line 1,128: | Line 1,128: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#DataRequestSubjectCVType DataRequestSubjectCVType] | ||
|Not apply | |Not apply | ||
| − | |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 obtain the evidence. | ||
|- | |- | ||
| Line 1,134: | Line 1,134: | ||
|anyUri | |anyUri | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
| | | | ||
|- | |- | ||
| Line 1,140: | Line 1,140: | ||
|[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType] | |[https://wiki.de4a.eu/index.php/Data_Dictionary#TimePeriodType TimePeriodType] | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Period dates of the subscription | |Period dates of the subscription | ||
|} | |} | ||
| Line 1,157: | Line 1,157: | ||
|dateTime | |dateTime | ||
|Not apply | |Not apply | ||
| − | |Y | + | |Y/Y |
|Subscription Start Date | |Subscription Start Date | ||
|- | |- | ||
| Line 1,163: | Line 1,163: | ||
|dateTime | |dateTime | ||
|Not apply | |Not apply | ||
| − | |N | + | |N/Y |
|Subscription End Date | |Subscription End Date | ||
|} | |} | ||
Revision as of 09:13, 18 May 2022
This document contains a basic detail about the messages exchanged in every step of the patterns for this iteration. More detailed information is available in the schema definition files.
RequestLookupRoutingInformationType
All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode.
Detailed information is available in ‘IAL Technical Design’ Document.
ResponseLookupRoutingInformationType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| ResponseLookupRoutingInformation | ResponseLookupRoutingInformationType | Not apply | Y/Y | Root element |
| ResponseItem | ResponseItemType | Cardinality 1..∞ | Y/Y | Contains a list of available sources obtained. |
| Error | ErrorType | Cardinality 1..∞ | Y/Y | Contains the response error. |
Schema XSD
ResponseItemType
Location: //ResponseLookupRoutingInformation/ResponseItemType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| ResponsePerCountry | ResponsePerCountryType | Cardinality 1..∞ | Y/Y | Contains the data for each source obtained. |
ResponsePerCountryType
Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| CountryCode | String | Attribute | Y/Y | The two-letter code of the DP country.
Format: ISO 3166-1 alfa-2 |
| Provision | ProvisionType | Cardinality 1..∞ | Y/Y |
ProvisionType
Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| AtuLevel | String | Enumerated | N/Y | Level of administration territorial unit.
nuts0: National level nuts1: Regional/Province level nuts2: Regional/Province level nuts3: Regional/Province level lau: Local level edu: Educational level |
| AtuCode | String | Not apply | N/Y | Code of the administrative territory unit.
ISO 3166-1 alfa-2 for nuts0 Region for nuts1-3 Municipality for lau Educational Organization for edu |
| AtuLatinName | String | Not apply | N/Y | Name of the administrative territorial unit. |
| DataOwnerId | anyURI | Not apply | N/Y | Identifies DataOwner in format iso6523. Define Party ID for all participants MUST be UNIQUE Format: {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id}iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15} {PEPPOL ParticipantIdentifierScheme}: Must be a constant “iso6523-actorid-upis” {Domain Scheme}: Identifies ICD value, must be 4 UNIQUE digits in PEPPOL {Party Id}: Identifies DE4A Partner, consisting of:
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 |
| DataOwnerPrefLabel | String | Not apply | N/Y | Name of the issuing DO from which the evidence is obtained. |
| ParameterSet | ParameterSetType | Not apply | Y/Y | Contains a list of necessary parameters for the requested evidence. |
ParameterSetType
Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision/ProvisionType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Title | String | Not apply | Y/Y | Name of the required parameter for the requested evidence. |
| Parameter | ParameterType | Cardinality 1..∞ | Y/Y | Contains the data for each necessary parameter of the requested evidence. |
ParameterType
Location: //ResponseLookupRoutingInformation/AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Name | String | Not apply | Y/Y | Name of the parameter |
| Optional | Boolean | Not apply | Y/Y | Indicates if the parameter is optional of not |
ErrorType
Location: //ResponseLookupRoutingInformation
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Code | String | Not apply | Y/Y | Error code occurred. See [FIX TABLE/DOCUMENT ERRORS] |
| Text | String | Not apply | Y/Y | Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS] |
RequestExtractMultiEvidenceIMType
Location: //RequestExtractMultiEvidenceIMType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceIMType | RequestExtractMultiEvidenceIMType | Not apply | Y/Y | Root element |
| RequestId | String | Not apply | Y/Y | Request message identifier |
| SpecificationId | String | Not apply | Y/Y | Version used and it will define the message structure. |
| Timestamp | Date | Not apply | 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 | Not apply | N/Y | Metadata about a procedure or public service. |
| DataEvaluator | AgentType | Not apply | Y/Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y/Y | Indentifier indicates the component responsible of issuing the evidence. |
| RequestEvidenceIMItem | RequestEvidenceItemType | Cardinality 1..∞ | Y/Y | Cardinality 1..∞ |
Schema XSD
AgentType
Location: //RequestExtractMultiEvidenceIMType/AgentType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| AgentUrn | anyURI | Not apply | Y/Y | Identifies DataOwner in format iso6523. Define Party ID for all participants MUST be UNIQUE Format: {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id}iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15} {PEPPOL ParticipantIdentifierScheme}: Must be a constant “iso6523-actorid-upis” {Domain Scheme}: Identifies ICD value, must be 4 UNIQUE digits in PEPPOL {Party Id}: Identifies DE4A Partner, consisting of:
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 |
| AgentName | String | Not apply | Y/N | Name of the agent Data Owner. |
| RedirectUrl | String | Not apply | Y/Y | Redirect URL to Data Owner. |
RequestEvidenceItemType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | Not apply | Y/Y | Evidence request unique id |
| DataRequestSubject | DataRequestSubjectCVType | Not apply | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | Not apply | Y/Y | Identifier of the canonical evidence type. Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
|
| RequestGrounds | RequestGrounds | Not apply | Y/Y | Request grounds to request evidence. |
| AdditionalParameter | AdditionalParameterType | Cardinality 1..∞ | N/Y | Contains each additional parameter necessary to request the evidence. |
DataRequestSubjectCVType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| DataSubjectPerson | NaturalPersonIdentifierType | Not apply | Y/Y | Contains the identifying details of the person to obtain the evidence. |
| DataSubjectCompany | LegalPersonIdentifierType | Not apply | Y/Y | Contains the identifying details of the company to obtain the evidence. |
| DataSubjectRepresentative | NaturalPersonIdentifierType | Not apply | N/Y | Contains the identifying details of the representative to obtain the evidence. |
NaturalPersonIdentifierType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/NaturalPersonIdentifierType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| PersonIdentifier | String | Not apply | Y/N | Unique identifier for the natural person as defined by the eIDAS Regulation. |
| FirstName | String | Not apply | Y/N | Current given names of the natural person. |
| FamilyName | String | Not apply | Y/N | Current family name of the natural person. |
| DateOfBirth | Date | Not apply | Y/Y | Date of birth for the natural person.
Format: YYYY-MM-DD |
| Gender | String | Enumetared | N/Y | Gender of the natural person.
Allowed values:
|
| BitrhName | String | Not apply | N/N | First name(s) and family name(s) of the natural person at birth. |
| PlaceOfBirth | String | Not apply | N/N | Place of birth for a natural person. |
| CurrentAddress | String | Not apply | N/N | Current address of the natural person as a base64 encoded string. |
LegalPersonIdentifierType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/LegalPersonIdentifierType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| LegalPersonIdentifier | String | Not apply | Y/N | Unique identifier for the legal person as defined by the eIDAS Regulation. |
| LegalName | String | Not apply | Y/N | Current legal name for the legal person or organisation. |
| LegalAddress | String | Not apply | 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 | Not apply | N/N | VAT - VAT registration number. |
| TaxReference | String | Not apply | N/N | TAX-Ref - tax reference number. |
| D-2012-17-EUIdentifier | String | Not apply | N/N | D-2012/17/EU - the identifier used under directive 2012/17/EU |
| LEI | String | Not apply | N/N | Legal Entity Identifier. |
| EORI | String | Not apply | N/N | Economic Operator Registration and Identification. |
| SEED | String | Not apply | N/N | System for Exchange of Excise Data. |
| SIC | String | Not apply | N/N | Standard Industrial Classification. |
RequestGroundsType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/RequestGrounds
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| LawELIPermanentLink | anyURI | Not apply | Y/Y | Permanent link allowing access to the system. |
| ExplicitRequest | token | Enumerated | Y/Y | Consent allowing access to the system.
Allowed values: SDGR14 |
AdditionalParameterType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/AdditionalPatameter
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Label | String | Not apply | Y/Y | Label identifying the required parameter. |
| Type | String | Enumerated | Y/Y | Type of the required parameter.
Allowed values:
|
| Value | String | Not apply | Y/Y | Value of the required parameter. |
ResponseExtractMultiEvidenceType
Location: //ResponseExtractMultiEvidenceType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceIMType | ResponseExtractMultiEvidenceType | Not apply | Y/Y | Root element |
| RequestId | String | Not apply | Y/Y | Request message identifier |
| Timestamp | Date | Not apply | 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 | Not apply | Y/Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | N/Y | Indentifier indicates the component responsible of issuing the evidence. |
| ResponseExtractEvidenceItem | ResponseExtractEvidenceItemType | Cardinality 1..∞ | Y/Y | Evidence requested |
Schema XSD
ResponseExtractEvidenceItemType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | Not apply | Y/Y | Evidence request unique id |
| DataRequestSubject | DataRequestSubjectCVType | Not apply | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | Not apply | Y/Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken> Allowed values for <canonical-evidence-type-idtoken>:
|
| CanonicalEvidence | CanonicalEvidenceType | lax | Y/Y | Canonical Evidence obtained. |
| DomesticEvidence | DomesticEvidenceType | Cardinality 1..∞ | Y/Y | Contains the data of each domestic evidences obtained. |
| Error | ErrorType | Cardinality 1..∞ | N/Y | Contains the data for each error that occurred. |
CanonicalEvidenceType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/CanonicalEvidence
DomesticEvidenceType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| IssuingType | Token | Enumerated | Y/Y | Indicates what type of evidence it is:
OriginalIssuing: Original Evidence MultinlingualFormIssuing: Multilingual evidence |
| MimeType | normalizedString | Enumerated | 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 | Not apply | 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 | Not apply | Y/Y | Contains the domestic that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64. |
| AdditionalInfo | TextType | Not apply | N/N | Contains additional information about domestic evidence. |
TextType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence/AdditionalInfo
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| languageID | language | Attribute | N/Y | The identifier of the language used in the content. |
| languageLocaleID | normalizedString | Attribute | N/Y | The identification of the locale of the language. |
RequestExtractMultiEvidenceUSIType
Location: //ResponseExtractMultiEvidenceUSIType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceUSIType | RequestExtractMultiEvidenceType | Not apply | Y/Y | Root element |
| RequestId | String | Not apply | Y/Y | Request message identifier |
| SpecificationId | String | Not apply | Y/Y | Version used and it will define the message structure. |
| Timestamp | Date | Not apply | 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 | Not apply | N/Y | Metadata about a procedure or public service. |
| DataEvaluator | AgentType | Not apply | Y/Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y/Y | Indentifier indicates the component responsible of issuing the evidence. |
| RequestEvidenceUSIItem | RequestEvidenceUSIItemType | Cardinality 1..∞ | Y/Y | Evidence requested |
Schema XSD
RequestExtractMultiEvidenceType
Location: //ResponseExtractMultiEvidenceUSIType/RequestEvidenceUSIItem
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | Not apply | Y/Y | Evidence request unique id |
| DataRequestSubject | DataRequestSubjectCVType | Not apply | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | Not apply | Y/Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
|
| RequestGrounds | RequestGrounds | Not apply | Y/Y | Request grounds to request evidence. |
| AdditionalParameter | AdditionalParameterType | Cardinality 1..∞ | N/Y | Contains each additional parameter necessary to request the evidence. |
| DataEvaluatorURL | anyUri | Not apply | Y/Y | Indicates the redirection url to return to the user. |
RedirectUserType
Location: //RedirectUserType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RedirectUserType | RedirectUserType | Not apply | Y/Y | Root element |
| RequestId | String | Not apply | Y/Y | Request message identifier |
| SpecificationId | String | Not apply | Y | Version used and it will define the message structure. |
| Timestamp | Date | Not apply | 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 | Not apply | Y/Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y/Y | Indentifier indicates the component responsible of issuing the evidence. |
| CanonicalEvidenceTypeId | String | Not apply | Y/Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken> Allowed values for <canonical-evidence-type-idtoken>:
|
| RedirectURL | anyURI | Not apply | Y/Y | Indicates the redirection url to return to the user. |
| Error | ErrorType | Cardinality 1..∞ | N/Y | Contains the response error. |
Schema XSD
RequestEventSubscriptionType
Location: //RequestEventSubscriptionType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestEventSubscriptionType | RequestEventSubscriptionType | Not apply | Y/Y | Root element |
| RequestId | String | Not apply | Y/Y | Request message identifier |
| SpecificationId | String | Not apply | Y/Y | Version used and it will define the message structure. |
| Timestamp | Date | Not apply | 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 | Not apply | N/Y | Metadata about a procedure or public service. |
| DataEvaluator | AgentType | Not apply | Y/Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y/Y | Indentifier indicates the component responsible of issuing the evidence. |
| EventSubscripRequestItem | EventSubscripRequestItemType | Cardinality 1..∞ | Y/Y | Evidence requested |
Schema XSD
EventSubscripRequestItemType
Location: //RequestEventSubscriptionType/EventSubscripRequestItem
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | string | Not apply | Y/Y | Evidence request unique id |
| DataRequestSubject | DataRequestSubjectCVType | Not apply | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEventCatalogUri | anyUri | Not apply | Y/Y | |
| SubscriptionPeriod | TimePeriodType | Not apply | Y/Y | Period dates of the subscription |
TimePeriodType
Location: //RequestEventSubscriptionType/EventSubscripRequestItem/SubscriptionPeriod
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| StartDate | dateTime | Not apply | Y/Y | Subscription Start Date |
| EndDate | dateTime | Not apply | N/Y | Subscription End Date |
ResponseEventSubscriptionType
Location: //ResponseEventSubscriptionType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| ResponseEventSubscriptionType | ResponseEventSubscriptionType | Not apply | Y | Root element |
| RequestId | String | Not apply | Y | Request message identifier |
| Timestamp | Date | Not apply | 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 | Not apply | Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y | Indentifier indicates the component responsible of issuing the evidence. |
| ResponseEventSubscriptionItem | ResponseEventSubscriptionItemType | Cardinality 1..∞ | Y | Evidence requested |
Schema XSD
ResponseEventSubscriptionItemType
Location: //ResponseEventSubscriptionType/ResponseEventSubscriptionItem
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | string | Not apply | Y | Evidence request unique id |
| CanonicalEventCatalogUri | anyUri | Not apply | Y | |
| SubscriptionPeriod | TimePeriodType | Not apply | Y | Period dates of the subscription |
EventNotificationType
Location: //EventNotificationType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| EventNotificationType | EventNotificationType | Not apply | Y | Root element |
| NotificationId | String | Not apply | Y | Request notification identifier |
| Timestamp | Date | Not apply | 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 | Not apply | Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y | Indentifier indicates the component responsible of issuing the evidence. |
| EventNotificationItem | EventNotificationItemType | Cardinality 1..∞ | Y | Evidence requested |
Schema XSD
EventNotificationItemType
Location: //EventNotificationType/EventNotificationItem
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| NotificationItemId | string | Not apply | Y | Notification unique id |
| EventId | string | Not apply | Y | Event unique id |
| EventSubject | DataRequestSubjectCVType | Not apply | Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEventCatalogUri | anyUri | Not apply | Y | |
| EventDate | Datetime | Not apply | Y | Date of the event notification |
| RelatedEventSubject | DataRequestSubjectCVType | Cardinality 1..∞ | Y |
RequestExtractMultiEvidenceLUType
Location: //RequestExtractMultiEvidenceLUType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceLUType | RequestExtractMultiEvidenceLUType | Not apply | Y | Root element |
| RequestId | String | Not apply | Y | Request message identifier |
| SpecificationId | String | Not apply | Y | Version used and it will define the message structure. |
| Timestamp | Date | Not apply | 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 | Not apply | N | Metadata about a procedure or public service. |
| DataEvaluator | AgentType | Not apply | Y | Identifier will be used to address the evidence back from the DataOwner. |
| DataOwner | AgentType | Not apply | Y | Indentifier indicates the component responsible of issuing the evidence. |
| RequestEvidenceLUItem | RequestEvidenceLUItemType | Cardinality 1..∞ | Y | Evidence requested |
Schema XSD
RequestEvidenceLUItemType
Location: //RequestExtractMultiEvidenceLUType/RequestEvidenceLUItem
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | Not apply | Y | Evidence request unique id |
| DataRequestSubject | DataRequestSubjectCVType | Not apply | Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | Not apply | Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
|
| RequestGrounds | RequestGrounds | Not apply | Y | Request grounds to request evidence. |
| AdditionalParameter | AdditionalParameterType | Cardinality 1..∞ | N/Y | Contains each additional parameter necessary to request the evidence. |
| EventNotificationRef | String | Not apply | Y | Reference of the notification event |
ResponseErrorType
Location: //ResponseErrorType
| Name | Type | Format | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Ack | boolean | Not apply | Y/Y | |
| Error | ErrorType | Not apply | N/Y | Error |