Contents

1. Introduction

In this section, some examples for the evidence exchange using the OOTS Exchange Data Model are provided. The Request-Response samples can be found in the OOTS-EDM/XML folder of the tdd_chapters git repository.

2. Example for requesting a birth certificate 

In this example, we consider the case of a natural person that needs to provide a prove of birth. Therefore an Evidence Requester is requesting a birth certificate on behalf of the natural person. To do this, an Evidence Request is sent, which contains information about who is participating in this data exchange and which DataServiceEvidenceType is required. The information about the required DataServiceEvidenceType has been received from the DSD. The request is sent to a service that can provide the evidence (Evidence Provider). The Evidence Provider then sends back to the Evidence Requester an Evidence Response that contains the certificates that has been requested. The  example can be also found in the git repository.

2.1. Step 1: Evidence Request Header and Evidence Request

The sender of the Evidence Request uses an ebMS message header that contains the Access Point identifiers as sender and receiver. Using an eDelivery AS4 profile enhancement, however, the outer corners, i.e. the Evidence Requester (originalSender) and Evidence Provider (finalRecipient), can be included in the ebMS message header. For the identification of the Access Points in the ebMS message header, i.e. the values to be used in the /PartyInfo/To/PartyId element are extracted from the DSD Response. The Evidence Request itself is referenced in the /PayloadInfo element. More information about the ebMS message header can be found at in the eDelivery Configuration.

Step 1: XML example of the ebMS message header for the Evidence Request
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Messaging mustUnderstand="false" xmlns="http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/">
    <UserMessage>
        <PartyInfo>
            <From>
                <PartyId type="urn:oasis:names:tc:ebcore:partyid-type:unregistered:oots-simulator"
                    >urn:oasis:names:tc:ebcore:partyid-type:unregistered:C2</PartyId>
                <Role>http://sdg.europa.eu/edelivery/gateway</Role>
            </From>
            <To>
                <PartyId type="urn:oasis:names:tc:ebcore:partyid-type:unregistered:oots-simulator"
                    >urn:oasis:names:tc:ebcore:partyid-type:unregistered:C3</PartyId>
                <Role>http://sdg.europa.eu/edelivery/gateway</Role>
            </To>
        </PartyInfo>
        <CollaborationInfo>
            <Service type="urn:oasis:names:tc:ebcore:ebrs:ebms:binding:1.0">QueryManager</Service>
            <Action>ExecuteQueryRequest</Action>
            <ConversationId>c73b7fdc-1ab0-4b1e-b295-ac9e4a35d764</ConversationId>
        </CollaborationInfo>
        <MessageProperties>
            <Property name="originalSender">urn:oasis:names:tc:ebcore:partyid-type:unregistered:C1</Property>
            <Property name="finalRecipient">urn:oasis:names:tc:ebcore:partyid-type:unregistered:C4</Property>
        </MessageProperties>
        <PayloadInfo>
            <PartInfo href="cid:regreprequest@example.oots.eu">
                <Schema/>
                <PartProperties>
                    <Property name="MimeType">application/x-ebrs+xml</Property>
                    <Property name="PayloadName">request.xml</Property>
                </PartProperties>
            </PartInfo>
        </PayloadInfo>
    </UserMessage>
</Messaging>

The Evidence Request itself contains information about the Evidence Requester who is requesting the birth certificate for a natural person from the Evidence Provider based on the underlying procedure and requirements. More information about how this information is represented within the XML document can be found in the Evidence Request Syntax Mapping

Step 1: XML example of Evidence Request for a birth certificate
<?xml version="1.0" encoding="UTF-8"?>
<query:QueryRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0"
                  xmlns:sdg="http://data.europa.eu/p4s"
                  xmlns:xmime="http://www.w3.org/2005/05/xmlmime" 
                  xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0"
                  xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0"
                  xmlns:xlink="http://www.w3.org/1999/xlink"
                  xmlns:xml="http://www.w3.org/XML/1998/namespace"
                  id="urn:uuid:4ffb5281-179d-4578-adf2-39fd13ccc797"> 
                  
	<rim:Slot name="SpecificationIdentifier">
		<rim:SlotValue xsi:type="rim:StringValueType">
			<rim:Value>oots-edm:v1.0</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="IssueDateTime">
		<rim:SlotValue xsi:type="rim:DateTimeValueType">
			<rim:Value>2022-05-19T17:08:10.872Z</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="Procedure">
		<rim:SlotValue xsi:type="rim:InternationalStringValueType">
			<rim:Value>
				<rim:LocalizedString xml:lang="en"
				                      value="Requesting a birth certificate"/>
			</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="PossibilityForPreview">
     	<rim:SlotValue xsi:type="rim:BooleanValueType">
         	<rim:Value>false</rim:Value>
     	</rim:SlotValue>
    </rim:Slot>	
    <rim:Slot name="ExplicitRequestGiven">
     	<rim:SlotValue xsi:type="rim:BooleanValueType">
         	<rim:Value>true</rim:Value>
     	</rim:SlotValue>
 	</rim:Slot>
	<rim:Slot name="Requirements">
    	<rim:SlotValue xsi:type="rim:CollectionValueType" 
    					collectionType="urn:oasis:names:tc:ebxml-regrep:CollectionType:Set">
        <rim:Element xsi:type="rim:AnyValueType">
            <rim:Requirement>
               <Identifier>315cfd75-6605-49c4-b0fe-799833b41099</Identifier>
               <Name lang="en">Proof of Birth</Name>
            </rim:Requirement>
        </rim:Element>
    	</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceRequester">
        <rim:SlotValue xsi:type="rim:CollectionValueType">
        	<rim:Element xsi:type="rim:AnyValueType">
            	<sdg:Agent>
					<sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0096">DK22233223</sdg:Identifier>
					<sdg:Name lang="en">Denmark University Portal</sdg:Name>
					<sdg:Classification>IntermediaryPlatform</sdg:Classification>
					<sdg:Address>
                    	<sdg:FullAddress>Prince Street 15</sdg:FullAddress>
						<sdg:LocatorDesignator>15</sdg:LocatorDesignator>
						<sdg:PostCode>1050</sdg:PostCode>
                    	<sdg:PostCityName>Copenhagen</sdg:PostCityName>
                    	<sdg:AdminUnitLevel1>Denmark</sdg:AdminUnitLevel1>
						<sdg:AdminUnitLevel2>DK011</sdg:AdminUnitLevel2>
                	</sdg:Address>
				</sdg:Agent>
        	</rim:Element>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceProvider">
		<rim:SlotValue xsi:type="rim:AnyValueType">
			<sdg:Agent>
				<sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE73524311</sdg:Identifier>
				<sdg:Name>Civil Registration Office Berlin I</sdg:Name>
			</sdg:Agent>
		</rim:SlotValue>
	</rim:Slot>
	<query:ResponseOption returnType="LeafClassWithRepositoryItem"/>
	<query:Query queryDefinition="DocumentQuery">
		<rim:Slot name="NaturalPerson">
			<rim:SlotValue xsi:type="rim:AnyValueType">
				<sdg:Person>
					<sdg:LevelOfAssurance>High</sdg:LevelOfAssurance>
					<sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier>
					<sdg:FamilyName>Smith</sdg:FamilyName>
					<sdg:GivenName>John</sdg:GivenName>
					<sdg:DateOfBirth>1970-03-01</sdg:DateOfBirth>
					<sdg:Gender>Male</sdg:Gender>
					<sdg:PlaceOfBirth>Hamburg, Germany</sdg:PlaceOfBirth>
					<sdg:CurrentAddress>
						<sdg:FullAddress>Dieter Wellhausen 71</sdg:FullAddress>
						<sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1>
					</sdg:CurrentAddress>
				</sdg:Person>
			</rim:SlotValue>
		</rim:Slot>
		<rim:Slot name="EvidenceRequest">
			<rim:SlotValue xsi:type="rim:AnyValueType">
				<sdg:DataServiceEvidenceType xmlns="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0">
					<sdg:Identifier>2af27699-f131-4411-8fdb-9e8cd4e8bded</sdg:Identifier>
					<sdg:EvidenceTypeClassification>CertificateOfBirth</sdg:EvidenceTypeClassification>
					<sdg:Title lang="en">Certificate of Birth</sdg:Title>
					<sdg:Title lang="de">Geburtsurkunde</sdg:Title>
					<sdg:DistributedAs>
						<sdg:Format>application/pdf</sdg:Format>
						<sdg:ConformsTo>https://semic.org/sa/common/birthcert-1.0.0</sdg:ConformsTo>
					</sdg:DistributedAs>
				</sdg:DataServiceEvidenceType>
			</rim:SlotValue>
		</rim:Slot>
	</query:Query>
</query:QueryRequest>

2.2. Step 2: Evidence Response Header and Evidence Response

Similar to the request, the sender of the Evidence Response uses an ebMS message header that contains the Access Point identifiers as sender and receiver. Next to the Evidence Request itself the requested evidence object is additionally included to the /PayloadInfo element of the ebMS message header. More information about the ebMS message header can be found at in the eDelivery Configuration.

Step 2: XML example of ebMS message header for the Evidence Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Messaging mustUnderstand="false" xmlns="http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/">
    <UserMessage>
        <PartyInfo>
            <From>
                <PartyId type="urn:oasis:names:tc:ebcore:partyid-type:unregistered:oots-simulator"
                    >urn:oasis:names:tc:ebcore:partyid-type:unregistered:C3</PartyId>
                <Role>http://sdg.europa.eu/edelivery/gateway</Role>
            </From>
            <To>
                <PartyId type="urn:oasis:names:tc:ebcore:partyid-type:unregistered:oots-simulator"
                    >urn:oasis:names:tc:ebcore:partyid-type:unregistered:C2</PartyId>
                <Role>http://sdg.europa.eu/edelivery/gateway</Role>
            </To>
        </PartyInfo>
        <CollaborationInfo>
            <Service type="urn:oasis:names:tc:ebcore:ebrs:ebms:binding:1.0">QueryManager</Service>
            <Action>ExecuteQueryResponse</Action>
            <ConversationId>c73b7fdc-1ab0-4b1e-b295-ac9e4a35d764</ConversationId>
        </CollaborationInfo>
        <MessageProperties>
            <Property name="originalSender">urn:oasis:names:tc:ebcore:partyid-type:unregistered:C4</Property>
            <Property name="finalRecipient">urn:oasis:names:tc:ebcore:partyid-type:unregistered:C1</Property>
        </MessageProperties>
        <PayloadInfo>
            <PartInfo href="cid:regrepresponse@example.oots.eu">
                <PartProperties>
                    <Property name="MimeType">application/x-ebrs+xml</Property>
                    <Property name="PayloadName">response.xml</Property>
                </PartProperties>
            </PartInfo>
			<PartInfo href="cid:attachment100001@example.oots.eu">
                <PartProperties>
                    <Property name="MimeType">application/pdf</Property>
                    <Property name="PayloadName">BirthCertificate.pdf</Property>
                </PartProperties>
            </PartInfo>
        </PayloadInfo>
    </UserMessage>
</Messaging>

The Evidence Response itself contains information about the Evidence Provider who is providing the birth certificate and its associated Evidence Metadata for a natural person based on the Evidence Request issued by the Evidence Requester. The /rim:RepositoryItemRef provides a references to the evidence object in the ebMS message header.  More information about how this information is represented within the XML document can be found in the Evidence Response Syntax Mapping

XML sample of Evidence Response for a birth certificate

Step 2: XML example of Evidence Response for a birth certificate
<?xml version="1.0" encoding="UTF-8"?>
 
<query:QueryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0"
    xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0"
    xmlns:sdg="http://data.europa.eu/p4s"
    xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0"
    xmlns:xlink="http://www.w3.org/1999/xlink"
    status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success"
    xmlns:xml="http://www.w3.org/XML/1998/namespace" 
    requestId="urn:uuid:4ffb5281-179d-4578-adf2-39fd13ccc797">
    
 
    <!-- Top Level Slots, providing metadata about the Response and the Evidence Provider -->
    <rim:Slot name="SpecificationIdentifier">
        <rim:SlotValue xsi:type="rim:StringValueType"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <rim:Value>oots-edm:v1.0</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceResponseIdentifier">
        <rim:SlotValue xsi:type="rim:StringValueType"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <rim:Value>166155eb-d7a7-4cac-9086-8a85f0116462</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="IssueDateTime">
        <rim:SlotValue xsi:type="rim:DateTimeValueType"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <rim:Value>2022-05-19T17:10:10.872Z</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceProvider">
        <rim:SlotValue xsi:type="rim:AnyValueType">
            <sdg:Agent>
                <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE73524311</sdg:Identifier>
                <sdg:Name lang="en">Civil Registration Office Berlin I</sdg:Name>
                <sdg:Classification>EvidenceProvider</sdg:Classification>
                <sdg:Address>
                        <sdg:FullAddress>Schönstedtstraße 5</sdg:FullAddress>
                        <sdg:LocatorDesignator>5</sdg:LocatorDesignator>
                        <sdg:PostCode>13357</sdg:PostCode>
                        <sdg:PostCityName>Berlin</sdg:PostCityName>
                        <sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1>  
                </sdg:Address>
            </sdg:Agent>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceRequester">
        <rim:SlotValue xsi:type="rim:AnyValueType">
            <sdg:Agent>
                <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0096">DK22233223</sdg:Identifier>
                <sdg:Name>Denmark University Portal</sdg:Name>
            </sdg:Agent>
        </rim:SlotValue>
    </rim:Slot>
    <rim:RegistryObjectList>
    <rim:RegistryObject xsi:type="rim:ExtrinsicObjectType" id="urn:uuid:555555-740e-4b64-80f0-2462462462">
        <rim:Slot name="EvidenceMetadata">
            <rim:SlotValue xsi:type="rim:AnyValueType">
                <sdg:Evidence>
                    <sdg:Identifier>37a169f1-9cf6-4aa8-ac24-b083fa569173 </sdg:Identifier>
                    <sdg:IsAbout>
                        <sdg:NaturalPerson>
                            <sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier>
                            <sdg:FamilyName>Smith</sdg:FamilyName>
                            <sdg:GivenName>John</sdg:GivenName>
                            <sdg:DateOfBirth>1970-03-01</sdg:DateOfBirth>
                        </sdg:NaturalPerson>
                    </sdg:IsAbout>
                    <sdg:IssuingAuthority>
                        <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE73524311</sdg:Identifier>
                        <sdg:Name lang="en">Civil Registration Office Berlin I</sdg:Name>
                    </sdg:IssuingAuthority>
                    <sdg:IsConformantTo>
                        <sdg:EvidenceTypeClassification>CertificateOfBirth</sdg:EvidenceTypeClassification>
                        <sdg:Title lang="en">Certificate of Birth</sdg:Title>
                        <sdg:Title lang="de">Geburtsurkunde</sdg:Title>
                        <sdg:Description lang="en">Civil status certificate created from the birth register</sdg:Description>
                        <sdg:Description lang="de">Personenstandsurkunde, die aus dem Geburtenregister erstellt wird</sdg:Description>
                    </sdg:IsConformantTo>
                    <sdg:IssuingDate>1970-03-03</sdg:IssuingDate>
                    <sdg:Distribution>
                        <sdg:Format>application/pdf</sdg:Format>
                    </sdg:Distribution>
                </sdg:Evidence>      
            </rim:SlotValue>
        </rim:Slot>           
        <!-- The attached Document Provided as Evidence. Points to an AS4 attachment -->
        <rim:RepositoryItemRef xlink:href="cid:attachment100001@example.oots.eu" xlink:title="BirthCertificate"/>
    </rim:RegistryObject>
</rim:RegistryObjectList>  
</query:QueryResponse>

3. Example for requesting Secondary Education Completion Evidence with Error Response requesting an Evidence Provider side Preview 

In this example, we consider the case of a natural person that needs to prove secondary education Completion. Therefore an Evidence Requester is requesting a Secondary Education Completion Evidence and its supplement on behalf of the natural person. To do this, an Evidence Request is sent, which contains information about who is participating in this data exchange and which DataServiceEvidenceType is required. The information about the required DataServiceEvidenceType has been received from the DSD. The request is sent to a service that can provide the evidence (Evidence Provider).

Since for this evidence type a preview on the side of the Evidence Provider is required, the Evidence Provider responds with an Error Response who rejects a direct evidence provision and informs the Evidence Requester about the required preview location, location and method provided for the Evidence Provider. The Evidence Requester than redirects the user (natural person) to the corresponding preview location and sends a second Evidence Request after the preview.  The Evidence Provider matches the second Evidence Request with the preview results and sends an Evidence Response with the the Secondary Education Completion Evidence and its supplement to the Evidence Requester.   

As the ebMS message header has been already introduced in the preview example illustrating the request for a birth certificate it is not repeated here even though it is needed for the message exchange. The complete example can be found in the git repository.

3.1 Step1: Initiating Evidence Request

The initating Evidence Request contains information about the Evidence Requester who is requesting the Secondary Education Completion Evidence for a natural person from the Evidence Provider based on the underlying procedure and requirements. More information about how this information is represented within the XML document can be found in the Evidence Request Syntax Mapping

Step 1: XML example of the initiating Evidence Request for a Secondary Education Completition Evidence
<?xml version="1.0" encoding="UTF-8"?><query:QueryRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0"
                  xmlns:sdg="http://data.europa.eu/p4s"
                  xmlns:xmime="http://www.w3.org/2005/05/xmlmime" 
                  xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0"
                  xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0"
                  xmlns:xlink="http://www.w3.org/1999/xlink"
                  xmlns:xml="http://www.w3.org/XML/1998/namespace"
                  id="urn:uuid:4ffb5281-179d-4578-adf2-39fd13ccc797"> 
                  
	<rim:Slot name="SpecificationIdentifier">
		<rim:SlotValue xsi:type="rim:StringValueType">
			<rim:Value>oots-edm:v1.0</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="IssueDateTime">
		<rim:SlotValue xsi:type="rim:DateTimeValueType">
			<rim:Value>2022-02-14T19:20:30+01:00</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="Procedure">
		<rim:SlotValue xsi:type="rim:InternationalStringValueType">
			<rim:Value>
				<rim:LocalizedString xml:lang="en"
				                      value="Requesting recognition of diploma"/>
			</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="PossibilityForPreview">
     	<rim:SlotValue xsi:type="rim:BooleanValueType">
         	<rim:Value>true</rim:Value>
     	</rim:SlotValue>
    </rim:Slot>	
    <rim:Slot name="ExplicitRequestGiven">
     	<rim:SlotValue xsi:type="rim:BooleanValueType">
         	<rim:Value>true</rim:Value>
     	</rim:SlotValue>
 	</rim:Slot>
	<rim:Slot name="Requirements">
    	<rim:SlotValue xsi:type="rim:CollectionValueType" 
    					collectionType="urn:oasis:names:tc:ebxml-regrep:CollectionType:Set">
        <rim:Element xsi:type="rim:AnyValueType">
            <rim:Requirement>
               <Identifier>315cfd75-6605-49c4-b0fe-799833b41099</Identifier>
               <Name lang="en">Proof of Secondary Education Completion</Name>
            </rim:Requirement>
        </rim:Element>
        <rim:Element xsi:type="rim:AnyValueType">
            <rim:Requirement>
               <Identifier>543-cfd75-6605-49c4-b0fe-799833b41111</Identifier>
               <Name lang="en">Proof of Secondary Education Completion Supplemenent Evidence</Name>
            </rim:Requirement>
        </rim:Element>
    	</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceRequester">
        <rim:SlotValue xsi:type="rim:CollectionValueType">
        	<rim:Element xsi:type="rim:AnyValueType">
            	<sdg:Agent>
					<sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0190">NL22233223</sdg:Identifier>
					<sdg:Name lang="en">University of Amsterdam</sdg:Name>
					<sdg:Classification>EvidenceRequester</sdg:Classification>
						<sdg:Address>
                    		<sdg:FullAddress>Binnengasthuisstraat 9</sdg:FullAddress>
                    		<sdg:LocatorDesignator>9</sdg:LocatorDesignator>
							<sdg:PostCode>1012</sdg:PostCode>
							<sdg:PostCityName>Amsterdam</sdg:PostCityName>
							<sdg:AdminUnitLevel1>NL</sdg:AdminUnitLevel1>
							<sdg:AdminUnitLevel2>NL329</sdg:AdminUnitLevel2>
                		</sdg:Address>
				</sdg:Agent>
        	</rim:Element>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceProvider">
		<rim:SlotValue xsi:type="rim:AnyValueType">
			<sdg:Agent>
				<sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0204">DE7657587001</sdg:Identifier>
				<sdg:Name>Authority for school and occupational training</sdg:Name>
			</sdg:Agent>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceProviderClassification">
		<rim:SlotValue xsi:type="rim:CollectionValueType">
			<rim:Element xsi:type="rim:AnyValueType">
				<sdg:EvidenceProviderClassification>
					<sdg:Identifier>SecondarySchool</sdg:Identifier>
					<sdg:SupportedValue>
						<sdg:StringValue>Wilhelm Gymnasium</sdg:StringValue>
					</sdg:SupportedValue>
				</sdg:EvidenceProviderClassification>
			</rim:Element>
			<rim:Element xsi:type="rim:AnyValueType">
				<sdg:EvidenceProviderClassification>
					<sdg:Identifier>YearOfGraduation</sdg:Identifier>
					<sdg:SupportedValue>
						<sdg:StringValue>1988</sdg:StringValue>
					</sdg:SupportedValue>
				</sdg:EvidenceProviderClassification>
			</rim:Element>
		</rim:SlotValue>
	</rim:Slot>
	<query:ResponseOption returnType="LeafClassWithRepositoryItem"/>
	<query:Query queryDefinition="DocumentQuery">
		<rim:Slot name="NaturalPerson">
			<rim:SlotValue xsi:type="rim:AnyValueType">
				<sdg:Person>
					<sdg:LevelOfAssurance>High</sdg:LevelOfAssurance>
					<sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier>
					<sdg:FamilyName>Smith</sdg:FamilyName>
					<sdg:GivenName>Jack</sdg:GivenName>
					<sdg:DateOfBirth>1970-03-01</sdg:DateOfBirth>
					<sdg:PlaceOfBirth>Dusseldorf</sdg:PlaceOfBirth>
					<sdg:CurrentAddress>
						<sdg:FullAddress>Lansstraße 81</sdg:FullAddress>
						<sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1>
					</sdg:CurrentAddress>
				</sdg:Person>
			</rim:SlotValue>
		</rim:Slot>
		<rim:Slot name="EvidenceRequest">
			<rim:SlotValue xsi:type="rim:AnyValueType">
				<sdg:DataServiceEvidenceType>
					<sdg:Identifier>487fdfdc-7f92-42bb-a690-dcbd3d65f435</sdg:Identifier>
					<sdg:EvidenceTypeClassification>SecondaryEducationCompletion</sdg:EvidenceTypeClassification>
					<sdg:Title lang="en">Secondary Education Completion Evidence</sdg:Title>
					<sdg:Title lang="de">Nachweis des Sekundarschulabschlusses</sdg:Title>
					<sdg:DistributedAs>
						<sdg:Format>application/pdf</sdg:Format>
						<sdg:ConformsTo>https://semic.org/sa/common/secondary-education-evidence-1.0.0</sdg:ConformsTo>
					</sdg:DistributedAs>
				</sdg:DataServiceEvidenceType>
			</rim:SlotValue>
		</rim:Slot>
	</query:Query>
</query:QueryRequest>

3.2 Step 2: Error Response

The response status provided by the Evidence Provider is declared as failure. The rs:Exception type provided by the Evidence Provider references to an authorization problem which requires a user redirection to a preview location where the user can preview, select and give his consent to use the evidence. Therefore the Evidence provider informs the Evdience Requester about the required preview location, location and method. More information about how this information is represented within the XML document can be found in the Error Response Syntax Mapping

Step 2: XML example of the Error Response returned by the Evidence Provider
<?xml version="1.0" encoding="UTF-8"?>
<query:QueryResponse xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0" 
    xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0" 
    xmlns:sdg="http://data.europa.eu/p4s"
    xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xlink="http://www.w3.org/1999/xlink"
    requestId="urn:uuid:4ffb5281-179d-4578-adf2-39fd13ccc797"
    status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Failure">
    <rim:Slot name="SpecificationIdentifier">
        <rim:SlotValue xsi:type="rim:StringValueType">
            <rim:Value>oots-edm:v1.0</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceResponseIdentifier">
        <rim:SlotValue xsi:type="rim:StringValueType">
            <rim:Value>530ad1e2-5eaf-4a9a-8192-227432eea95d</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="ErrorProvider">
        <rim:SlotValue xsi:type="rim:AnyValueType">
            <sdg:Agent>
                <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0204">DE7657587001</sdg:Identifier>
                <sdg:Name>Authority for school and occupational training</sdg:Name>
                <sdg:Classification>IntermediaryPlatform</sdg:Classification>
                <sdg:Address>
                    <sdg:FullAddress>Hamburger Str. 31</sdg:FullAddress>
                    <sdg:LocatorDesignator>31</sdg:LocatorDesignator>
                    <sdg:PostCode>22083</sdg:PostCode>
                    <sdg:PostCityName>Hamburg</sdg:PostCityName>
                    <sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1>
                    <sdg:AdminUnitLevel2>DE60</sdg:AdminUnitLevel2>
                </sdg:Address>
            </sdg:Agent>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceRequester">
        <rim:SlotValue xsi:type="rim:AnyValueType">
            <sdg:Agent>
                <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0190">NL22233223</sdg:Identifier>
                <sdg:Name lang="en">University of Amsterdam</sdg:Name>
            </sdg:Agent>  
        </rim:SlotValue>
    </rim:Slot>
    <rs:Exception xsi:type="rs:AuthorizationExceptionType"   severity="urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Error"
        message="User redirection required"  >
        <rim:Slot name="Timestamp">
            <rim:SlotValue xsi:type="rim:DateTimeValueType">
                <rim:Value>2020-02-14T19:21:30+01:00</rim:Value>
            </rim:SlotValue>
        </rim:Slot>
        <rim:Slot name="PreviewLocation">
            <rim:SlotValue xsi:type="rim:StringValueType">
                <rim:Value>https://preview.space.example.com/requests?session=d36af8bc-fea6-4ee5-a32d-5bef82cdb071</rim:Value>
            </rim:SlotValue>
        </rim:Slot>
        <rim:Slot name="PreviewDescription">
            <rim:SlotValue xsi:type="rim:InternationalStringValueType">
                <rim:Value>
                    <rim:LocalizedString xml:lang="nl" value="Kies uw diploma."/>
                    <rim:LocalizedString xml:lang="ro" value="Vă rugăm să selectați diploma dvs."/>
                    <rim:LocalizedString xml:lang="en" value="Please select your diploma."/>
                </rim:Value>
            </rim:SlotValue>
        </rim:Slot>
        <rim:Slot name="PreviewMethod">
            <rim:SlotValue xsi:type="rim:StringValueType">
                <rim:Value>GET</rim:Value>
            </rim:SlotValue>
        </rim:Slot>
    </rs:Exception>
</query:QueryResponse>

3.3 Step 3: Second Evidence Request

The Evidence Requester redirects the user (natural person) to the corresponding preview location. After the execution of the preview the Evidence Requester sends a second Evidence Request to the Evidence Provider containing the preview location. More information about how this information is represented within the XML document can be found in the Evidence Request Syntax Mapping

Step 3: XML example of the second Evidence Request for a Secondary Education Completition Evidence
<?xml version="1.0" encoding="UTF-8"?>
<query:QueryRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0"
                  xmlns:sdg="http://data.europa.eu/p4s"
                  xmlns:xmime="http://www.w3.org/2005/05/xmlmime" 
                  xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0"
                  xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0"
                  xmlns:xlink="http://www.w3.org/1999/xlink"
                  xmlns:xml="http://www.w3.org/XML/1998/namespace"            
                  id="urn:uuid:bc2842c1-6625-450d-a7c6-7d692230b753">

	<rim:Slot name="SpecificationIdentifier">
		<rim:SlotValue xsi:type="rim:StringValueType">
			<rim:Value>oots-edm:v1.0</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="IssueDateTime">
		<rim:SlotValue xsi:type="rim:DateTimeValueType">
			<rim:Value>2022-02-15T19:20:30+01:00</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="Procedure">
		<rim:SlotValue xsi:type="rim:InternationalStringValueType">
			<rim:Value>
				<rim:LocalizedString xml:lang="en"
									 value="Requesting recognition of diploma"/>
			</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="PreviewLocation">
		<rim:SlotValue xsi:type="rim:StringValueType">
			<rim:Value>https://preview.space.example.com/requests?session=d36af8bc-fea6-4ee5-a32d-5bef82cdb071</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="PossibilityForPreview">
		<rim:SlotValue xsi:type="rim:BooleanValueType">
			<rim:Value>true</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="ExplicitRequestGiven">
		<rim:SlotValue xsi:type="rim:BooleanValueType">
			<rim:Value>true</rim:Value>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="Requirements">
		<rim:SlotValue xsi:type="rim:CollectionValueType"
					   collectionType="urn:oasis:names:tc:ebxml-regrep:CollectionType:Set">
			<rim:Element xsi:type="rim:AnyValueType">
				<rim:Requirement>
					<Identifier>315cfd75-6605-49c4-b0fe-799833b41099</Identifier>
					<Name lang="en">Proof of Secondary Education Completion</Name>
				</rim:Requirement>
			</rim:Element>
			<rim:Element xsi:type="rim:AnyValueType">
				<rim:Requirement>
					<Identifier>543-cfd75-6605-49c4-b0fe-799833b41111</Identifier>
					<Name lang="en">Proof of Secondary Education Completion Supplemenent Evidence</Name>
				</rim:Requirement>
			</rim:Element>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceRequester">
		<rim:SlotValue xsi:type="rim:CollectionValueType">
			<rim:Element xsi:type="rim:AnyValueType">
				<sdg:Agent>
					<sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0190">NL22233223</sdg:Identifier>
					<sdg:Name lang="en">University of Amsterdam</sdg:Name>
					<sdg:Classification>EvidenceRequester</sdg:Classification>
					<sdg:Address>
						<sdg:FullAddress>Binnengasthuisstraat 9</sdg:FullAddress>
						<sdg:LocatorDesignator>9</sdg:LocatorDesignator>
						<sdg:PostCode>1012</sdg:PostCode>
						<sdg:PostCityName>Amsterdam</sdg:PostCityName>
						<sdg:AdminUnitLevel1>NL</sdg:AdminUnitLevel1>
						<sdg:AdminUnitLevel2>NL329</sdg:AdminUnitLevel2>
					</sdg:Address>
				</sdg:Agent>
			</rim:Element>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceProvider">
		<rim:SlotValue xsi:type="rim:AnyValueType">
			<sdg:Agent>
				<sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0204">DE7657587001</sdg:Identifier>
				<sdg:Name>Authority for school and occupational training</sdg:Name>
			</sdg:Agent>
		</rim:SlotValue>
	</rim:Slot>
	<rim:Slot name="EvidenceProviderClassification">
		<rim:SlotValue xsi:type="rim:CollectionValueType">
			<rim:Element xsi:type="rim:AnyValueType">
				<sdg:EvidenceProviderClassification>
					<sdg:Identifier>SecondarySchool</sdg:Identifier>
					<sdg:SupportedValue>
						<sdg:StringValue>Wilhelm Gymnasium</sdg:StringValue>
					</sdg:SupportedValue>
				</sdg:EvidenceProviderClassification>
			</rim:Element>
			<rim:Element xsi:type="rim:AnyValueType">
				<sdg:EvidenceProviderClassification>
					<sdg:Identifier>YearOfGraduation</sdg:Identifier>
					<sdg:SupportedValue>
						<sdg:StringValue>1988</sdg:StringValue>
					</sdg:SupportedValue>
				</sdg:EvidenceProviderClassification>
			</rim:Element>
		</rim:SlotValue>
	</rim:Slot>
	<query:ResponseOption returnType="LeafClassWithRepositoryItem"/>
	<query:Query queryDefinition="DocumentQuery">
		<rim:Slot name="NaturalPerson">
			<rim:SlotValue xsi:type="rim:AnyValueType">
				<sdg:Person>
					<sdg:LevelOfAssurance>High</sdg:LevelOfAssurance>
					<sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier>
					<sdg:FamilyName>Smith</sdg:FamilyName>
					<sdg:GivenName>Jack</sdg:GivenName>
					<sdg:DateOfBirth>1970-03-01</sdg:DateOfBirth>
					<sdg:PlaceOfBirth>Dusseldorf</sdg:PlaceOfBirth>
					<sdg:CurrentAddress>
						<sdg:FullAddress>Lansstraße 81</sdg:FullAddress>
						<sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1>
					</sdg:CurrentAddress>
				</sdg:Person>
			</rim:SlotValue>
		</rim:Slot>
		<rim:Slot name="EvidenceRequest">
			<rim:SlotValue xsi:type="rim:AnyValueType">
				<sdg:DataServiceEvidenceType>
					<sdg:Identifier>487fdfdc-7f92-42bb-a690-dcbd3d65f435</sdg:Identifier>
					<sdg:EvidenceTypeClassification>SecondaryEducationCompletion</sdg:EvidenceTypeClassification>
					<sdg:Title lang="en">Secondary Education Completion Evidence</sdg:Title>
					<sdg:Title lang="de">Nachweis des Sekundarschulabschlusses</sdg:Title>
					<sdg:DistributedAs>
						<sdg:Format>application/pdf</sdg:Format>
						<sdg:ConformsTo>https://semic.org/sa/common/secondary-education-evidence-1.0.0</sdg:ConformsTo>
					</sdg:DistributedAs>
				</sdg:DataServiceEvidenceType>
			</rim:SlotValue>
		</rim:Slot>
	</query:Query>
</query:QueryRequest>

3.4 Step 4: Evidence Response

After the execution of the preview and a matching of the preview results with the second Evidence Request, the Evidence Provider sends an Evidence Response with the Secondary Education Completion Evidence and its supplement to the Evidence Requester. More information about how this information is represented within the XML document can be found in the Evidence Response Syntax Mapping

Step 4: XML example of Evidence Response for a Secondary Education Completition Evidence
<?xml version="1.0" encoding="UTF-8"?>
 
<query:QueryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0"
    xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0"
    xmlns:sdg="http://data.europa.eu/p4s"
    xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0"
    xmlns:xlink="http://www.w3.org/1999/xlink"
    status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success"
    xmlns:xml="http://www.w3.org/XML/1998/namespace" 
    requestId="urn:uuid:bc2842c1-6625-450d-a7c6-7d692230b753">
    
 
    <!-- Top Level Slots, providing metadata about the Response and the Evidence Provider -->
    <rim:Slot name="SpecificationIdentifier">
        <rim:SlotValue xsi:type="rim:StringValueType"
                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <rim:Value>oots-edm:v1.0</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceResponseIdentifier">
        <rim:SlotValue xsi:type="rim:StringValueType">
            <rim:Value>5af62cce-debe-11ec-9d64-0242ac120002</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="IssueDateTime">
        <rim:SlotValue xsi:type="rim:DateTimeValueType">
            <rim:Value>2022-02-14T19:20:30+02:00</rim:Value>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceProvider">
        <rim:SlotValue xsi:type="rim:AnyValueType">
            <sdg:Agent>
                <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0204">DE7657587001</sdg:Identifier>
                <sdg:Name>Authority for school and occupational training</sdg:Name>
                <sdg:Classification>IntermediaryPlatform</sdg:Classification>
                <sdg:Address>
                    <sdg:FullAddress>Hamburger Str. 31</sdg:FullAddress>
                    <sdg:LocatorDesignator>31</sdg:LocatorDesignator>
                    <sdg:PostCode>22083</sdg:PostCode>
                    <sdg:PostCityName>Hamburg</sdg:PostCityName>
                    <sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1>
                    <sdg:AdminUnitLevel2>DE60</sdg:AdminUnitLevel2>
                </sdg:Address>
            </sdg:Agent>
        </rim:SlotValue>
    </rim:Slot>
    <rim:Slot name="EvidenceRequester">
        <rim:SlotValue xsi:type="rim:AnyValueType">
            <sdg:Agent>
                <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0190">NL22233223</sdg:Identifier>
                <sdg:Name lang="en">University of Amsterdam</sdg:Name>
            </sdg:Agent>
        </rim:SlotValue>
    </rim:Slot>
    <rim:RegistryObjectList>
    <rim:RegistryObject xsi:type="rim:ExtrinsicObjectType" id="urn:uuid:555555-740e-4b64-80f0-2462462462">
        <rim:Slot name="EvidenceMetadata">
            <rim:SlotValue xsi:type="rim:AnyValueType">
                <sdg:Evidence>
                    <sdg:Identifier>7c2e04cf-7d20-4363-908d-827817746725</sdg:Identifier>
                    <sdg:IsAbout>
                        <sdg:NaturalPerson>
                            <sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier>
                            <sdg:FamilyName>Smith</sdg:FamilyName>
                            <sdg:GivenName>Jack</sdg:GivenName>
                            <sdg:DateOfBirth>1970-03-01</sdg:DateOfBirth>
                            <sdg:PlaceOfBirth>Dusseldorf</sdg:PlaceOfBirth>
                        </sdg:NaturalPerson>
                    </sdg:IsAbout>
                    <sdg:IssuingAuthority>
                        <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE7657587001</sdg:Identifier>
                        <sdg:Name>Wilhelm Gymnasium</sdg:Name>
                    </sdg:IssuingAuthority>
                    <sdg:IsConformantTo>
                        <sdg:EvidenceTypeClassification>SecondaryEducationCompletion</sdg:EvidenceTypeClassification>
                        <sdg:Title lang="en">Secondary Education Completion Evidence</sdg:Title>
                        <sdg:Title lang="de">Nachweis des Sekundarschulabschlusses</sdg:Title>
                        <sdg:Description lang="de">Nachweis über den Abschluss der Sekundarstufe II</sdg:Description>
                        <sdg:Description lang="en">Proof of completion of secondary education second stage</sdg:Description>
                    </sdg:IsConformantTo>
                    <sdg:IssuingDate>1988-05-10</sdg:IssuingDate>
                    <sdg:Distribution>
                        <sdg:Format>application/pdf</sdg:Format>
                    </sdg:Distribution>
                </sdg:Evidence>         
            </rim:SlotValue>
        </rim:Slot>           
        <!-- The attached Document Provided as Evidence. Points to an AS4 attachment -->
        <rim:RepositoryItemRef xlink:href="cid:attachment100001@example.oots.eu" xlink:title="SecondaryEducationCompletion"/>
    </rim:RegistryObject>
    <rim:RegistryObject xsi:type="rim:ExtrinsicObjectType" id="urn:uuid:555555-740e-4b64-80f0-2462462462">
        <rim:Slot name="EvidenceMetadata">
            <rim:SlotValue xsi:type="rim:AnyValueType">
                <sdg:Evidence>
                    <sdg:Identifier>5ee5c0de-c066-4637-bea3-6e3511ada970</sdg:Identifier>
                    <sdg:IsAbout>
                        <sdg:NaturalPerson>
                            <sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier>
                            <sdg:FamilyName>Smith</sdg:FamilyName>
                            <sdg:GivenName>Jack</sdg:GivenName>
                            <sdg:DateOfBirth>1970-03-01</sdg:DateOfBirth>
                            <sdg:PlaceOfBirth>Dusseldorf</sdg:PlaceOfBirth>
                        </sdg:NaturalPerson>
                    </sdg:IsAbout>
                    <sdg:IssuingAuthority>
                        <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE7657587001</sdg:Identifier>
                        <sdg:Name>Wilhelm Gymnasium</sdg:Name>
                    </sdg:IssuingAuthority>
                    <sdg:IsConformantTo>
                        <sdg:EvidenceTypeClassification>SecondaryEducationCompletion</sdg:EvidenceTypeClassification>
                        <sdg:Title lang="en">Secondary Education Completion Evidence Supplement</sdg:Title>
                        <sdg:Title lang="de">Anhang zum Nachweis des Sekundarschulabschlusses</sdg:Title>
                        <sdg:Description lang="en">The Supplement of the Secondary Education Completion Evidence Supplement to understand the qualification.</sdg:Description>
                        <sdg:Description lang="de">Die Anlage zum Nachweis des Sekundarschulabschlusses, um die Qualifikation zu verstehen.</sdg:Description>
                    </sdg:IsConformantTo>
                    <sdg:IssuingDate>1988-05-10</sdg:IssuingDate>
                    <sdg:Distribution>
                        <sdg:Format>application/pdf</sdg:Format>
                    </sdg:Distribution>
                </sdg:Evidence>
            </rim:SlotValue>
        </rim:Slot>           
        <!-- The attached Document Provided as Evidence. Points to an AS4 attachment -->
        <rim:RepositoryItemRef xlink:href="cid:attachment100002@example.oots.eu" xlink:title="SecondaryEducationCompletionSupplement"/>
    </rim:RegistryObject>
</rim:RegistryObjectList>  
</query:QueryResponse>
  • No labels