Class XRoadHeader

Combines X-Road SOAP headers for X-Road v6.

Inheritance
System.Object
AbstractXRoadHeader
XRoadHeader
Inherited Members
Namespace: XRoad
Assembly: XRoadProvider.dll
Syntax
[<AllowNullLiteral>]
type XRoadHeader ()
    inherit AbstractXRoadHeader

Constructors

new: unit -> XRoadHeader

Implicit constructor.

Declaration
new: unit -> XRoadHeader
Returns
Type Description
XRoadHeader

new: XRoadHeader -> XRoadHeader

Declaration
new: other:XRoadHeader -> XRoadHeader
Parameters
Type Name Description
XRoadHeader other
Returns
Type Description
XRoadHeader

Properties

property CentralService: XRoadCentralServiceIdentifier

Identifies the central service that is invoked by the request.

Declaration
property CentralService: XRoadCentralServiceIdentifier with get, set
Property Value
Type Description
XRoadCentralServiceIdentifier

property Client: XRoadMemberIdentifier

Identifies a service client – an entity that initiates the service call.

Declaration
property Client: XRoadMemberIdentifier with get, set
Property Value
Type Description
XRoadMemberIdentifier

property Issue: string

Identifies received application, issue or document that was the cause of the service request. This field may be used by the client information system to connect service requests (and responses) to working procedures.

Declaration
property Issue: string with get, set
Property Value
Type Description
string

property Producer: XRoadMemberIdentifier

Identifies the service that is invoked by the request.

Declaration
property Producer: XRoadMemberIdentifier with get, set
Property Value
Type Description
XRoadMemberIdentifier

property ProtocolVersion: string

X-Road message protocol version. The value of this field MUST be 4.0

Declaration
property ProtocolVersion: string with get, set
Property Value
Type Description
string

property RequestHash: string

For responses, this field contains a Base64 encoded hash of the request SOAP message. This field is automatically filled in by the service provider's security server.

Declaration
property RequestHash: string with get, set
Property Value
Type Description
string

property RequestHashAlgorithm: string

Identifies the hash algorithm that was used to calculate the value of the requestHash field. The algorithms are specified as URIs listed in the XML-DSIG specification [DSIG].

Declaration
property RequestHashAlgorithm: string with get, set
Property Value
Type Description
string

property UserId: string

User whose action initiated the request. The user ID should be prefixed with two-letter ISO country code (e.g., EE12345678901).

Declaration
property UserId: string with get, set
Property Value
Type Description
string