rqes-data-classes/at.asitplus.rqes/SignDocRequestParameters

SignDocRequestParameters

@Serializable

data class SignDocRequestParameters( val credentialId: String? = null, val sad: String? = null, val operationMode: OperationMode? = OperationMode.SYNCHRONOUS, val validityPeriod: Int? = null, val responseUri: String? = null, val clientData: String? = null, val signatureQualifier: SignatureQualifier? = null, val documentDigests: Collection<DocumentDigest>? = null, val documents: Collection<Document>? = null, val returnValidationInformation: Boolean? = false) : QtspSignatureRequest(source)

CSC API v2.0.0.2 Data class defined in Ch. 11.11 Used to request the creation of one or more AdES signature(s).

Constructors

constructor( credentialId: String? = null, sad: String? = null, operationMode: OperationMode? = OperationMode.SYNCHRONOUS, validityPeriod: Int? = null, responseUri: String? = null, clientData: String? = null, signatureQualifier: SignatureQualifier? = null, documentDigests: Collection<DocumentDigest>? = null, documents: Collection<Document>? = null, returnValidationInformation: Boolean? = false)

Properties

clientData

@SerialName(value = "clientData")

open override val clientData: String? = null

OPTIONAL. Arbitrary data from the signature application. It can be used to handle a transaction identifier or other application-spe cific data that may be useful for debugging purposes

credentialId

@SerialName(value = "credentialID")

open override val credentialId: String? = null

REQUIRED-CONDITIONAL. The credentialID as defined in the Input parameter table in /credentials/info At least one of the two values credentialID and signatureQualifier SHALL be present. Both values MAY be present.

documentDigests

@SerialName(value = "documentDigests")

val documentDigests: Collection<DocumentDigest>? = null

REQUIRED-CONDITIONAL. An array containing JSON objects containing a hash value representing one or more SDRs, the respective digest algorithm OID used to calculate this hash value and further request parameters. This parameter or the parameter documents MUST be present in a request.

documents

@SerialName(value = "documents")

val documents: Collection<Document>? = null

REQUIRED-CONDITIONAL. An array containing JSON objects, each of them containing a base64-encoded document content to be signed and further request parameter. This parameter or the parameter documentDigests MUST be present in a request.

operationMode

@SerialName(value = "operationMode")

open override val operationMode: OperationMode?

OPTIONAL. The type of operation mode requested to the remote signing server The default value is “S”, so if the parameter is omitted then the remote signing server will manage the request in synchronous operation mode.

responseUri

@SerialName(value = "response_uri")

open override val responseUri: String? = null

OPTIONAL-CONDITIONAL. Value of one location where the server will notify the signature creation operation completion, as an URI value. This parameter MAY be specified only if the parameter operationMode is “A”.

returnValidationInformation

@SerialName(value = "returnValidationInformation")

val returnValidationInformation: Boolean? = false

OPTIONAL. This parameter SHALL be set to “true” to request the service to return the “validationInfo”. The default value is “false”, i.e. no “validationInfo” info is provided.

sad

@SerialName(value = "SAD")

open override val sad: String? = null

REQUIRED-CONDITIONAL. The Signature Activation Data returned by the Credential Authorization methods. Not needed if the signing application has passed an access token in the “Authorization” HTTP header with scope “credential”, which is also good for the credential identified by credentialID. Note: For backward compatibility, signing applications MAY pass access tokens with scope “credential” in this parameter.

signatureQualifier

@SerialName(value = "signatureQualifier")

val signatureQualifier: SignatureQualifier? = null

REQUIRED-CONDITIONAL. Identifier of the signature type to be created, e.g. “eu_eidas_qes” to denote a Qualified Electronic Signature according to eIDAS

validityPeriod

@SerialName(value = "validity_period")

open override val validityPeriod: Int? = null

OPTIONAL-CONDITIONAL. Maximum period of time, expressed in milliseconds, until which the server SHALL keep the request outcome(s) available for the client application retrieval. This parameter MAY be specified only if the parameter operationMode is “A”.