This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/.
1 Introduction
This specification describes an extension to the X-Road Message Protocol 4.0 [PR-MESS].
The purpose of this extension is to allow sending of additional information to the X-Road service providers in case when service client represents third party while issuing a query. The query is initiated by a third party and the results are also forwarded to that third party, but the request itself is signed by service client.
The described scenario can be used by MISP and other portals that offer X-Road services to various types of institutions. These institutions may not be X-Road members and even may not be eligible for becoming ones, but the service agreements between service providers and service clients may allow service clients to forward data received from X-Road services to these institutions.
1.1 Terms and abbreviations
See X-Road terms and abbreviations documentation [TA-TERMS]
1.2 References
Document ID
[PR-MESS]
[TA-TERMS]
2 Format of Messages
This section describes XML-based data formats for expressing the represented parties. The data structures and elements defined in this section are in the namespace http://x-road.eu/xsd/representation.xsd. The schema file can be found at http://x-road.eu/xsd/representation.xsd. The XML Schema for this extension is also listed in the section Annex A XML Schema for Representation.
2.1 Schema Header
The following listing shows the header of the schema definition.
The XRoadRepresentedPartyType complex type is used to describe represented parties. It consists of two elements: partyClass and partyCode. The partyCode element is mandatory and the partyClass element is optional.
Next, the elements used in the XRoadRepresentedPartyType are defined. Element partyClass is similar to the element memberClass described in the X-Road Message Protocol 4.0 [PR-MESS], but can additionally identify institutions that can not become members of X-Road.
Element partyCode is used to uniquely identify represented parties.
This section describes the additional SOAP headers that are added by this extension. The header fields are described in Table 1.
Table 1. Supported header fields
Field
Type
Mandatory /Optional
Description
representedParty
XRoadRepresentedPartyType
O
Identifies a party that is being represented in a service request
Annex A XML Schema for Representation
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://x-road.eu/xsd/representation.xsd"
xmlns="http://x-road.eu/xsd/representation.xsd">
<xs:element name="partyClass" type="xs:string">
<xs:annotation>
<xs:documentation>Class of the represented party.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="partyCode" type="xs:string">
<xs:annotation>
<xs:documentation>Code of the represented party.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="XRoadRepresentedPartyType">
<xs:sequence>
<xs:element minOccurs="0" ref="partyClass"/>
<xs:element minOccurs="1" ref="partyCode"/>
</xs:sequence>
</xs:complexType>
<xs:element name="representedParty" type="XRoadRepresentedPartyType">
<xs:annotation>
<xs:documentation>Identifies a party that is being
represented in a service request.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
