Class XRoadDocHeader

Combines X-Road SOAP headers for document style messages.

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

Constructors

new: unit -> XRoadDocHeader

Implicit constructor.

Declaration
new: unit -> XRoadDocHeader
Returns
Type Description
XRoadDocHeader

new: XRoadDocHeader -> XRoadDocHeader

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

Properties

property Async: Nullable<bool>

Specifies asynchronous service. If the value is "true", then the security server performs the service call asynchronously.

Declaration
property Async: Nullable<bool> with get, set
Property Value
Type Description
System.Nullable<bool>

property Authenticator: string

Authentication method, one of the following: ID-CARD - with a certificate of identity; CERT - with another certificate; EXTERNAL - through a third-party service; PASSWORD - with user ID and a password. Details of the authentication (e.g. the identification of a bank for external authentication) can be given in brackets after the authentication method.

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

property Consumer: string

DNS-name of the institution

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

property Encrypt: string

If an organization has got the right from the X-Road Center to hide queries, with the database agreeing to hide the query, the occurrence of this tag in the query header makes the database security server to encrypt the query log, using the encryption key of the X-Road Center.

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

property EncryptCert: byte []

Authentication certificate of the query invokers ID Card, in the base64-encoded DER format. Occurrence of this tag in the query header represents the wish to encrypt the query log in the organizations security server, using authentication key of the query invokers ID Card. This field is used in the Citizen Query Portal only.

Declaration
property EncryptCert: byte [] with get, set
Property Value
Type Description
byte []

property Encrypted: string

If the query header contains the encrypt tag and the query log as been successfully encrypted, an empty encrypted tag will be inserted in the reply header.

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

property EncryptedCert: string

If the query header contains the encryptedCert tag and the query log has been successfully encrypted, an empty encryptedCert tag will accordingly be inserted in the reply header.

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

property Issue: string

Name of file or document related to the service invocation.

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

property Paid: string

The amount of money paid for invoking the service.

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

property Position: string

Organizational position or role of the person invoking the service.

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

property Producer: string

DNS-name of the database

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

property Unit: string

Registration code of the institution or its unit on whose behalf the service is used (applied in the legal entity portal).

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

property UserId: string

ID code of the person invoking the service, preceded by a two-letter country code. For example: EE37702026518.

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

property UserName: string

Name of the person invoking the service.

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