Difference between revisions of "Data Dictionary"

From DE4A
Jump to navigation Jump to search
Line 88: Line 88:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 94: Line 94:
 
|AtuLevel
 
|AtuLevel
 
|String
 
|String
−
| Enumerated
+
| 1
 
|N/Y
 
|N/Y
 
|Level of administration territorial unit.
 
|Level of administration territorial unit.
Line 108: Line 108:
 
|AtuCode
 
|AtuCode
 
|String
 
|String
−
|Not apply
+
|1
 
|N/Y
 
|N/Y
 
| Code of the administrative territory unit.  
 
| Code of the administrative territory unit.  
Line 121: Line 121:
 
|AtuLatinName
 
|AtuLatinName
 
|String
 
|String
−
|Not apply
+
|1
 
|N/Y
 
|N/Y
 
|Name of the Administrative Territorial Unit.
 
|Name of the Administrative Territorial Unit.
Line 127: Line 127:
 
|DataOwnerId
 
|DataOwnerId
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
 
|N/Y
 
|N/Y
 
|Identifies the Data Owner in iso6523 format<br />Defines Party ID for all participants
 
|Identifies the Data Owner in iso6523 format<br />Defines Party ID for all participants
Line 154: Line 154:
 
|DataOwnerPrefLabel
 
|DataOwnerPrefLabel
 
|String
 
|String
−
|Not apply
+
|1
 
|N/Y
 
|N/Y
 
|Name of the issuing DO from which the evidence is obtained.
 
|Name of the issuing DO from which the evidence is obtained.
Line 160: Line 160:
 
|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/Y
 
|Contains a list of necessary parameters for the requested evidence.
 
|Contains a list of necessary parameters for the requested evidence.
Line 173: Line 173:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 179: Line 179:
 
|Title
 
|Title
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Name of the required parameter for the requested evidence.
 
|Name of the required parameter for the requested evidence.
Line 185: Line 185:
 
|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/Y
 
|Contains the data for each necessary parameter of the requested evidence.
 
|Contains the data for each necessary parameter of the requested evidence.
Line 196: Line 196:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 202: Line 202:
 
|Name
 
|Name
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Name of the parameter  
 
|Name of the parameter  
Line 208: Line 208:
 
|Optional
 
|Optional
 
|Boolean
 
|Boolean
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Indicates whether the parameter is optional or not
 
|Indicates whether the parameter is optional or not
Line 219: Line 219:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 225: Line 225:
 
|Code
 
|Code
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Code of the error occurred. See [FIX TABLE/DOCUMENT ERRORS]
 
|Code of the error occurred. See [FIX TABLE/DOCUMENT ERRORS]
Line 231: Line 231:
 
|Text
 
|Text
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS]
 
|Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS]
Line 242: Line 242:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 248: Line 248:
 
|RequestExtractMultiEvidenceIMType
 
|RequestExtractMultiEvidenceIMType
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Root element
 
|Root element
Line 254: Line 254:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Request message identifier  
 
|Request message identifier  
Line 260: Line 260:
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Version used and it will define the message structure.  
 
|Version used and it will define the message structure.  
Line 266: Line 266:
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute  
 
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute  
Line 273: Line 273:
 
|ProcedureId
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|1
 
|N/Y
 
|N/Y
 
|Metadata about a procedure or public service.  
 
|Metadata about a procedure or public service.  
Line 279: Line 279:
 
|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/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 285: Line 285:
 
|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/Y
 
|Indentifier indicates the component responsible of issuing the evidence.  
 
|Indentifier indicates the component responsible of issuing the evidence.  
Line 291: Line 291:
 
|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/Y
 
|Cardinality 1..∞  
 
|Cardinality 1..∞  
Line 305: Line 305:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 311: Line 311:
 
|AgentUrn
 
|AgentUrn
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Identifies DataOwner in format iso6523.<br />Define Party ID for all participants
 
|Identifies DataOwner in format iso6523.<br />Define Party ID for all participants
Line 339: Line 339:
 
|AgentName
 
|AgentName
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/N
 
|Y/N
 
|Name of the agent Data Owner.  
 
|Name of the agent Data Owner.  
Line 345: Line 345:
 
|RedirectUrl
 
|RedirectUrl
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/Y
 
|N/Y
 
|Redirect URL to Data Owner.  
 
|Redirect URL to Data Owner.  
Line 356: Line 356:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 362: Line 362:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Unique evidence request ID
 
|Unique evidence request ID
Line 369: Line 369:
 
|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/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 375: Line 375:
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Identifier of the canonical evidence type.<br />'''Format:'''  
 
|Identifier of the canonical evidence type.<br />'''Format:'''  
Line 391: Line 391:
 
|RequestGrounds
 
|RequestGrounds
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGroundsType RequestGroundsType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestGroundsType RequestGroundsType]
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Request grounds to request evidence.  
 
|Request grounds to request evidence.  
Line 397: Line 397:
 
|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/Y
 
|N/Y
 
|Contains each additional parameter necessary to request the evidence.  
 
|Contains each additional parameter necessary to request the evidence.  
Line 408: Line 408:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 414: Line 414:
 
|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/Y
 
|Contains the identifying details of the person to obtain the evidence.  
 
|Contains the identifying details of the person to obtain the evidence.  
Line 421: Line 421:
 
|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/Y
 
|Contains the identifying details of the company to obtain the evidence.  
 
|Contains the identifying details of the company to obtain the evidence.  
Line 427: Line 427:
 
|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/Y
 
|N/Y
 
|Contains the identifying details of the representative to obtain the evidence.  
 
|Contains the identifying details of the representative to obtain the evidence.  
Line 438: Line 438:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 444: Line 444:
 
|PersonIdentifier
 
|PersonIdentifier
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/N
 
|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 451: Line 451:
 
|FirstName
 
|FirstName
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/N
 
|Y/N
 
|Current given names of the natural person.  
 
|Current given names of the natural person.  
Line 457: Line 457:
 
|FamilyName
 
|FamilyName
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/N
 
|Y/N
 
|Current family name of the natural person.  
 
|Current family name of the natural person.  
Line 463: Line 463:
 
|DateOfBirth
 
|DateOfBirth
 
|Date
 
|Date
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Date of birth for the natural person.  
 
|Date of birth for the natural person.  
Line 471: Line 471:
 
|Gender
 
|Gender
 
|String
 
|String
−
|Enumetared
+
|0..1
 
|N/Y
 
|N/Y
 
|Gender of the natural person.  
 
|Gender of the natural person.  
Line 483: Line 483:
 
|BitrhName
 
|BitrhName
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/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.  
Line 489: Line 489:
 
|PlaceOfBirth
 
|PlaceOfBirth
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|Place of birth for a natural person.  
 
|Place of birth for a natural person.  
Line 495: Line 495:
 
|CurrentAddress
 
|CurrentAddress
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/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 506: Line 506:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 512: Line 512:
 
|LegalPersonIdentifier
 
|LegalPersonIdentifier
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/N
 
|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 519: Line 519:
 
|LegalName
 
|LegalName
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/N
 
|Y/N
 
|Current legal name for the legal person or organisation.  
 
|Current legal name for the legal person or organisation.  
Line 525: Line 525:
 
|LegalAddress
 
|LegalAddress
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/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 533: Line 533:
 
|VATRegistration
 
|VATRegistration
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|VAT - VAT registration number.  
 
|VAT - VAT registration number.  
Line 539: Line 539:
 
|TaxReference
 
|TaxReference
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|TAX-Ref - tax reference number.  
 
|TAX-Ref - tax reference number.  
Line 545: Line 545:
 
|D-2012-17-EUIdentifier
 
|D-2012-17-EUIdentifier
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|D-2012/17/EU - the identifier used under directive 2012/17/EU  
 
|D-2012/17/EU - the identifier used under directive 2012/17/EU  
Line 551: Line 551:
 
|LEI
 
|LEI
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|Legal Entity Identifier.  
 
|Legal Entity Identifier.  
Line 557: Line 557:
 
|EORI
 
|EORI
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|Economic Operator Registration and Identification.  
 
|Economic Operator Registration and Identification.  
Line 563: Line 563:
 
|SEED
 
|SEED
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|System for Exchange of Excise Data.  
 
|System for Exchange of Excise Data.  
Line 569: Line 569:
 
|SIC
 
|SIC
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/N
 
|N/N
 
|Standard Industrial Classification.  
 
|Standard Industrial Classification.  
Line 580: Line 580:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 586: Line 586:
 
|LawELIPermanentLink
 
|LawELIPermanentLink
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Permanent link allowing access to the system.  
 
|Permanent link allowing access to the system.  
Line 593: Line 593:
 
|ExplicitRequest  
 
|ExplicitRequest  
 
|token
 
|token
−
|Enumerated
+
|1
 
|Y/Y
 
|Y/Y
 
|Consent allowing access to the system.  
 
|Consent allowing access to the system.  
Line 607: Line 607:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 613: Line 613:
 
|Label
 
|Label
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Label identifying the required parameter.  
 
|Label identifying the required parameter.  
Line 620: Line 620:
 
|Type
 
|Type
 
|String
 
|String
−
|Enumerated
+
|1
 
|Y/Y
 
|Y/Y
 
|Type of the required parameter.  
 
|Type of the required parameter.  
Line 631: Line 631:
 
|Value
 
|Value
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Value of the required parameter.  
 
|Value of the required parameter.  
Line 642: Line 642:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 648: Line 648:
 
|RequestExtractMultiEvidenceIMType
 
|RequestExtractMultiEvidenceIMType
 
|ResponseExtractMultiEvidenceType
 
|ResponseExtractMultiEvidenceType
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Root element
 
|Root element
Line 654: Line 654:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Request message identifier
 
|Request message identifier
Line 660: Line 660:
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute 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 666: Line 666:
 
|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/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 672: Line 672:
 
|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
 
|N/Y
 
|N/Y
 
|Indentifier indicates the component responsible of issuing the evidence.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 678: Line 678:
 
|ResponseExtractEvidenceItem
 
|ResponseExtractEvidenceItem
 
|ResponseExtractEvidenceItemType
 
|ResponseExtractEvidenceItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y/Y
 
|Y/Y
 
|Evidence requested  
 
|Evidence requested  
Line 692: Line 692:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 698: Line 698:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Unique evidence request ID
 
|Unique evidence request ID
Line 705: Line 705:
 
|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/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 711: Line 711:
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Identifier of the canonical evidence type.  
 
|Identifier of the canonical evidence type.  
Line 729: Line 729:
 
|CanonicalEvidence
 
|CanonicalEvidence
 
|CanonicalEvidenceType
 
|CanonicalEvidenceType
−
|lax
+
|1
 
|Y/Y
 
|Y/Y
 
|Canonical Evidence obtained.  
 
|Canonical Evidence obtained.  
Line 735: Line 735:
 
|DomesticEvidence
 
|DomesticEvidence
 
|DomesticEvidenceType
 
|DomesticEvidenceType
−
|Cardinality 1..∞
+
|0..n
 
|Y/Y
 
|Y/Y
 
|Contains the data of each domestic evidences obtained.  
 
|Contains the data of each domestic evidences obtained.  
Line 741: Line 741:
 
|Error
 
|Error
 
|ErrorType
 
|ErrorType
−
|Cardinality 1..∞
+
|1..n
 
|N/Y
 
|N/Y
 
|Contains the data for each error that occurred.  
 
|Contains the data for each error that occurred.  
Line 755: Line 755:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 761: Line 761:
 
|IssuingType
 
|IssuingType
 
|Token
 
|Token
−
|Enumerated
+
|1
 
|Y/Y
 
|Y/Y
 
|Indicates what type of evidence it is:  
 
|Indicates what type of evidence it is:  
Line 772: Line 772:
 
|MimeType
 
|MimeType
 
|normalizedString  
 
|normalizedString  
−
|Enumerated
+
|1
 
|Y/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
Line 778: Line 778:
 
|DataLanguage
 
|DataLanguage
 
|language
 
|language
−
|Not apply
+
|1
 
|Y/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.<br />'''Values conform to <nowiki>RFC 3066</nowiki>, allowed values:'''<br />Conformity to ISO 639
Line 789: Line 789:
 
|EvidenceData
 
|EvidenceData
 
|base64Binary
 
|base64Binary
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Contains the domestic that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64.  
 
|Contains the domestic that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64.  
Line 795: Line 795:
 
|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/N
 
|Contains additional information about domestic evidence.  
 
|Contains additional information about domestic evidence.  
Line 805: Line 805:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 811: Line 811:
 
|languageID
 
|languageID
 
|language
 
|language
−
|Attribute
+
|0..1
 
|N/Y
 
|N/Y
 
|The identifier of the language used in the content.  
 
|The identifier of the language used in the content.  
Line 818: Line 818:
 
|languageLocaleID
 
|languageLocaleID
 
|normalizedString
 
|normalizedString
−
|Attribute
+
|0..1
 
|N/Y
 
|N/Y
 
|The identification of the locale of the language.  
 
|The identification of the locale of the language.  
Line 829: Line 829:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 835: Line 835:
 
|RequestExtractMultiEvidenceUSIType
 
|RequestExtractMultiEvidenceUSIType
 
|RequestExtractMultiEvidenceType
 
|RequestExtractMultiEvidenceType
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Root element
 
|Root element
Line 841: Line 841:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Request message identifier
 
|Request message identifier
Line 847: Line 847:
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Version used and it will define the message structure.
 
|Version used and it will define the message structure.
Line 853: Line 853:
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute 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 859: Line 859:
 
|ProcedureId
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/Y
 
|N/Y
 
|Metadata about a procedure or public service.
 
|Metadata about a procedure or public service.
Line 865: Line 865:
 
|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/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 871: Line 871:
 
|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/Y
 
|Indentifier indicates the component responsible of issuing the evidence.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 877: Line 877:
 
|RequestEvidenceUSIItem
 
|RequestEvidenceUSIItem
 
|RequestEvidenceUSIItemType
 
|RequestEvidenceUSIItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y/Y
 
|Y/Y
 
|Evidence requested
 
|Evidence requested
Line 891: Line 891:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 897: Line 897:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Unique evidence request ID
 
|Unique evidence request ID
Line 904: Line 904:
 
|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/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 910: Line 910:
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Identifier of the canonical evidence type.
 
|Identifier of the canonical evidence type.
Line 925: Line 925:
 
|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/Y
 
|Request grounds to request evidence.
 
|Request grounds to request evidence.
Line 931: Line 931:
 
|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/Y
 
|N/Y
 
|Contains each additional parameter necessary to request the evidence.
 
|Contains each additional parameter necessary to request the evidence.
Line 937: Line 937:
 
|DataEvaluatorURL
 
|DataEvaluatorURL
 
|anyUri
 
|anyUri
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Indicates the redirection url to return the user to the e-procedure portal of the data evaluator
 
|Indicates the redirection url to return the user to the e-procedure portal of the data evaluator
Line 948: Line 948:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 954: Line 954:
 
|RedirectUserType
 
|RedirectUserType
 
|RedirectUserType
 
|RedirectUserType
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Root element
 
|Root element
Line 960: Line 960:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Request message identifier
 
|Request message identifier
Line 966: Line 966:
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Version used and it will define the message structure.
 
|Version used and it will define the message structure.
Line 972: Line 972:
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute 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 978: Line 978:
 
|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/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 984: Line 984:
 
|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/Y
 
|Indentifier indicates the component responsible of issuing the evidence.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 990: Line 990:
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Identifier of the canonical evidence type.  
 
|Identifier of the canonical evidence type.  
Line 1,008: Line 1,008:
 
|RedirectURL
 
|RedirectURL
 
|anyURI
 
|anyURI
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Indicates the redirection url for the user to choose and preview the evidence.
 
|Indicates the redirection url for the user to choose and preview the evidence.
Line 1,014: Line 1,014:
 
|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
 
|N/Y
 
|N/Y
 
|Contains the response error.
 
|Contains the response error.
Line 1,028: Line 1,028:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,034: Line 1,034:
 
|RequestEventSubscriptionType
 
|RequestEventSubscriptionType
 
|RequestEventSubscriptionType
 
|RequestEventSubscriptionType
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Root element
 
|Root element
Line 1,040: Line 1,040:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Request message identifier
 
|Request message identifier
Line 1,046: Line 1,046:
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Version used and it will define the message structure.
 
|Version used and it will define the message structure.
Line 1,052: Line 1,052:
 
|Timestamp
 
|Timestamp
 
|Date
 
|Date
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute 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,058: Line 1,058:
 
|ProcedureId
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N/Y
 
|N/Y
 
|Metadata about a procedure or public service.
 
|Metadata about a procedure or public service.
Line 1,064: Line 1,064:
 
|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/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,070: Line 1,070:
 
|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/Y
 
|Indentifier indicates the component responsible of issuing the evidence.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 1,076: Line 1,076:
 
|EventSubscripRequestItem
 
|EventSubscripRequestItem
 
|EventSubscripRequestItemType
 
|EventSubscripRequestItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y/Y
 
|Y/Y
 
|Evidence requested
 
|Evidence requested
Line 1,090: Line 1,090:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,096: Line 1,096:
 
|RequestItemId
 
|RequestItemId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Unique evidence request ID
 
|Unique evidence request ID
Line 1,102: Line 1,102:
 
|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/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,108: Line 1,108:
 
|CanonicalEventCatalogUri
 
|CanonicalEventCatalogUri
 
|anyUri
 
|anyUri
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|
 
|
Line 1,114: Line 1,114:
 
|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/Y
 
|Period dates of the subscription
 
|Period dates of the subscription
Line 1,125: Line 1,125:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,131: Line 1,131:
 
|StartDate
 
|StartDate
 
|dateTime
 
|dateTime
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|Subscription Start Date
 
|Subscription Start Date
Line 1,137: Line 1,137:
 
|EndDate
 
|EndDate
 
|dateTime
 
|dateTime
−
|Not apply
+
|0..1
 
|N/Y
 
|N/Y
 
|Subscription End Date
 
|Subscription End Date
Line 1,148: Line 1,148:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,154: Line 1,154:
 
|ResponseEventSubscriptionType
 
|ResponseEventSubscriptionType
 
|ResponseEventSubscriptionType
 
|ResponseEventSubscriptionType
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Root element
 
|Root element
Line 1,160: Line 1,160:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Request message identifier
 
|Request message identifier
Line 1,166: Line 1,166:
 
|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 when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
Line 1,172: Line 1,172:
 
|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.
 
|Identifier will be used to address the evidence back from the DataOwner.
Line 1,178: Line 1,178:
 
|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.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 1,184: Line 1,184:
 
|ResponseEventSubscriptionItem
 
|ResponseEventSubscriptionItem
 
|ResponseEventSubscriptionItemType
 
|ResponseEventSubscriptionItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y
 
|Y
 
|Evidence requested
 
|Evidence requested
Line 1,198: Line 1,198:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,204: Line 1,204:
 
|RequestItemId
 
|RequestItemId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Unique evidence request ID
 
|Unique evidence request ID
Line 1,210: Line 1,210:
 
|CanonicalEventCatalogUri
 
|CanonicalEventCatalogUri
 
|anyUri
 
|anyUri
−
|Not apply
+
|1
 
|Y
 
|Y
 
|
 
|
Line 1,216: Line 1,216:
 
|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
 
|Period dates of the subscription
Line 1,227: Line 1,227:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,233: Line 1,233:
 
|EventNotificationType
 
|EventNotificationType
 
|EventNotificationType
 
|EventNotificationType
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Root element
 
|Root element
Line 1,239: Line 1,239:
 
|NotificationId
 
|NotificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Request notification identifier
 
|Request notification identifier
Line 1,245: Line 1,245:
 
|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 when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
Line 1,251: Line 1,251:
 
|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.
 
|Identifier will be used to address the evidence back from the DataOwner.
Line 1,257: Line 1,257:
 
|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.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 1,263: Line 1,263:
 
|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
 
|Evidence requested
Line 1,277: Line 1,277:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,283: Line 1,283:
 
|NotificationItemId
 
|NotificationItemId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Unique notification ID
 
|Unique notification ID
Line 1,289: Line 1,289:
 
|EventId
 
|EventId
 
|string
 
|string
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Unique event ID
 
|Unique event ID
Line 1,295: Line 1,295:
 
|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 person, company or representative to obtain the evidence.
Line 1,301: Line 1,301:
 
|CanonicalEventCatalogUri
 
|CanonicalEventCatalogUri
 
|anyUri
 
|anyUri
−
|Not apply
+
|1
 
|Y
 
|Y
 
|
 
|
Line 1,307: Line 1,307:
 
|EventDate
 
|EventDate
 
|Datetime
 
|Datetime
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Date of the event notification
 
|Date of the event notification
Line 1,313: Line 1,313:
 
|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
 
|
 
|
Line 1,324: Line 1,324:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,330: Line 1,330:
 
|RequestExtractMultiEvidenceLUType
 
|RequestExtractMultiEvidenceLUType
 
|RequestExtractMultiEvidenceLUType
 
|RequestExtractMultiEvidenceLUType
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Root element
 
|Root element
Line 1,336: Line 1,336:
 
|RequestId
 
|RequestId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Request message identifier
 
|Request message identifier
Line 1,342: Line 1,342:
 
|SpecificationId
 
|SpecificationId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Version used and it will define the message structure.
 
|Version used and it will define the message structure.
Line 1,348: Line 1,348:
 
|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 when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
Line 1,354: Line 1,354:
 
|ProcedureId
 
|ProcedureId
 
|String
 
|String
−
|Not apply
+
|0..1
 
|N
 
|N
 
|Metadata about a procedure or public service.
 
|Metadata about a procedure or public service.
Line 1,360: Line 1,360:
 
|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.
 
|Identifier will be used to address the evidence back from the DataOwner.
Line 1,366: Line 1,366:
 
|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.
 
|Indentifier indicates the component responsible of issuing the evidence.
Line 1,372: Line 1,372:
 
|RequestEvidenceLUItem
 
|RequestEvidenceLUItem
 
|RequestEvidenceLUItemType
 
|RequestEvidenceLUItemType
−
|Cardinality 1..∞
+
|1..n
 
|Y
 
|Y
 
|Evidence requested
 
|Evidence requested
Line 1,386: Line 1,386:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,392: Line 1,392:
 
|RequestItemId
 
|RequestItemId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Unique evidence request ID
 
|Unique evidence request ID
Line 1,399: Line 1,399:
 
|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 obtain the evidence.
Line 1,405: Line 1,405:
 
|CanonicalEvidenceTypeId
 
|CanonicalEvidenceTypeId
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Identifier of the canonical evidence type.
 
|Identifier of the canonical evidence type.
Line 1,419: Line 1,419:
 
|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.
 
|Request grounds to request evidence.
Line 1,425: Line 1,425:
 
|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/Y
 
|N/Y
 
|Contains each additional parameter necessary to request the evidence.
 
|Contains each additional parameter necessary to request the evidence.
Line 1,431: Line 1,431:
 
|EventNotificationRef
 
|EventNotificationRef
 
|String
 
|String
−
|Not apply
+
|1
 
|Y
 
|Y
 
|Reference of the notification event
 
|Reference of the notification event
Line 1,442: Line 1,442:
 
!Name
 
!Name
 
!Type
 
!Type
−
!Format
+
!Cardinality
 
!Mandatory Field / Label
 
!Mandatory Field / Label
 
!Description
 
!Description
Line 1,448: Line 1,448:
 
|Ack
 
|Ack
 
|boolean
 
|boolean
−
|Not apply
+
|1
 
|Y/Y
 
|Y/Y
 
|
 
|
Line 1,454: Line 1,454:
 
|Error
 
|Error
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ErrorType ErrorType]
−
|Not apply
+
|0..n
 
|N/Y
 
|N/Y
 
|Error
 
|Error

Revision as of 11:42, 12 August 2022

This document contains a basic detail about the messages exchanged in every step of the patterns for this iteration. More detailed information is available in the schema definition files.

RequestLookupRoutingInformationType

All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode.

Detailed information is available in ‘IAL Technical Design’ Document.

ResponseLookupRoutingInformationType

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

Schema XSD

IAL.xsd

ResponseItemType

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

ResponsePerCountryType

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

Format: ISO 3166-1 alfa-2

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

Provision ProvisionType 1..n Y/Y

ProvisionType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision
ComplexType ProvisionType.jpg
Name Type Cardinality Mandatory Field / Label Description
AtuLevel String 1 N/Y Level of administration 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 territory 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
Defines 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 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
  • 7 digits for DE4A Partner

For regional or local administrations, the entity type is 99 and the 7 digit number is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until 7 digits.

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

Example of Dutch Province of Groningen with NUTS code NL11: NL990000011

https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf

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 parameter for the requested evidence.
Parameter ParameterType 1..n Y/Y Contains the data for each necessary parameter of the requested evidence.

ParameterType

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

ErrorType

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

RequestExtractMultiEvidenceIMType

ComplexType RequestExtractMultiEvidenceIMType.jpg 
Location: //RequestExtractMultiEvidenceIMType
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType 1 Y/Y Root element
RequestId String 1 Y/Y Request message identifier
SpecificationId String 1 Y/Y Version used and it will define the message structure.
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 1 N/Y Metadata about a procedure or public service.
DataEvaluator AgentType 1 Y/Y Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y/Y Indentifier indicates the component responsible of issuing the evidence.
RequestEvidenceIMItem RequestEvidenceItemType 1..n Y/Y Cardinality 1..∞

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 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:

  • 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

AgentName String 1 Y/N Name of the agent Data Owner.
RedirectUrl String 0..1 N/Y Redirect URL to Data Owner.

RequestEvidenceItemType

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

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

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

  • HigherEducationDiploma
  • DomicileRegistrationEvidence
  • BirthCertificate
  • MarriageCertificate
  • CompanyRegistration
RequestGrounds RequestGroundsType 1 Y/Y Request grounds to request evidence.
AdditionalParameter AdditionalParameterType 0..n N/Y Contains each additional parameter necessary to request the evidence.

DataRequestSubjectCVType

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

NaturalPersonIdentifierType

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

Format: YYYY-MM-DD

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

Allowed values:

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

LegalPersonIdentifierType

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

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

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

RequestGroundsType

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

Allowed values:

SDGR14

AdditionalParameterType

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

Allowed values:

  • Date à Date tye
  • InputText à Input Text type
  • YesNo à Selector Yes/No type
Value String 1 Y/Y Value of the required parameter.

ResponseExtractMultiEvidenceType

ComplexType ResponseExtractMultiEvidenceType.jpg 
Location: //ResponseExtractMultiEvidenceType
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceIMType ResponseExtractMultiEvidenceType 1 Y/Y Root element
RequestId String 1 Y/Y Request message identifier
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 Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 N/Y Indentifier indicates the component responsible of issuing the evidence.
ResponseExtractEvidenceItem ResponseExtractEvidenceItemType 1..n Y/Y Evidence requested

Schema XSD

common-types.xsd

ResponseExtractEvidenceItemType

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

Format:

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

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

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

CanonicalEvidenceType

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

DomesticEvidenceType

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

OriginalIssuing: Original Evidence

MultinlingualFormIssuing: Multilingual evidence

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

Conformity to ISO 3166

Languages registered by the Internet Assigned Numbers Authority (IANA)

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

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

TextType

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

RequestExtractMultiEvidenceUSIType

Location: //ResponseExtractMultiEvidenceUSIType
ComplexType RequestExtractMultiEvidenceUSIType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceType 1 Y/Y Root element
RequestId String 1 Y/Y Request message identifier
SpecificationId String 1 Y/Y Version used and it will define the message structure.
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 a procedure or public service.
DataEvaluator AgentType 1 Y/Y Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y/Y Indentifier indicates the component responsible of issuing the evidence.
RequestEvidenceUSIItem RequestEvidenceUSIItemType 1..n Y/Y Evidence requested

Schema XSD

common-types.xsd

RequestExtractMultiEvidenceType

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

Format:

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

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

RedirectUserType

Location: //RedirectUserType
ComplexType RedirectUserType.jpg
Name Type Cardinality Mandatory Field / Label Description
RedirectUserType RedirectUserType 1 Y/Y Root element
RequestId String 1 Y/Y Request message identifier
SpecificationId String 1 Y Version used and it will define the message structure.
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 Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y/Y Indentifier indicates the component responsible of issuing the evidence.
CanonicalEvidenceTypeId String 1 Y/Y Identifier of the canonical evidence type.

Format:

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

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

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

Schema XSD

common-types.xsd

RequestEventSubscriptionType

Location: //RequestEventSubscriptionType
ComplexType RequestEventSubscriptionType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestEventSubscriptionType RequestEventSubscriptionType 1 Y/Y Root element
RequestId String 1 Y/Y Request message identifier
SpecificationId String 1 Y/Y Version used and it will define the message structure.
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 a procedure or public service.
DataEvaluator AgentType 1 Y/Y Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y/Y Indentifier indicates the component responsible of issuing the evidence.
EventSubscripRequestItem EventSubscripRequestItemType 1..n Y/Y Evidence requested

Schema XSD

common-types.xsd

EventSubscripRequestItemType

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

TimePeriodType

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

ResponseEventSubscriptionType

Location: //ResponseEventSubscriptionType
ComplexType ResponseEventSubscriptionType.jpg
Name Type Cardinality Mandatory Field / Label Description
ResponseEventSubscriptionType ResponseEventSubscriptionType 1 Y Root element
RequestId String 1 Y Request message 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 Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y Indentifier indicates the component responsible of issuing the evidence.
ResponseEventSubscriptionItem ResponseEventSubscriptionItemType 1..n Y Evidence requested

Schema XSD

common-types.xsd

ResponseEventSubscriptionItemType

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

EventNotificationType

Location: //EventNotificationType
ComplexType EventNotificationType.jpg
Name Type Cardinality Mandatory Field / Label Description
EventNotificationType EventNotificationType 1 Y Root element
NotificationId String 1 Y Request notification identifier
Timestamp Date 1 Y Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
DataEvaluator AgentType 1 Y Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y Indentifier indicates the component responsible of issuing the evidence.
EventNotificationItem EventNotificationItemType 1..n Y Evidence requested

Schema XSD

common-types.xsd

EventNotificationItemType

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

RequestExtractMultiEvidenceLUType

Location: //RequestExtractMultiEvidenceLUType
ComplexType RequestExtractMultiEvidenceLUType.jpg
Name Type Cardinality Mandatory Field / Label Description
RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType 1 Y Root element
RequestId String 1 Y Request message identifier
SpecificationId String 1 Y Version used and it will define the message structure.
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 a procedure or public service.
DataEvaluator AgentType 1 Y Identifier will be used to address the evidence back from the DataOwner.
DataOwner AgentType 1 Y Indentifier indicates the component responsible of issuing the evidence.
RequestEvidenceLUItem RequestEvidenceLUItemType 1..n Y Evidence requested

Schema XSD

common-types.xsd

RequestEvidenceLUItemType

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

Format:

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

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

ResponseErrorType

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

Schema XSD

common-types.xsd

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