/Signatures
Description
Creates a new signature. The properties of the signature must be transferred in the body of the request.
Request
URI Parameters
shallOverwrite
boolean
Default value is: True
Gibt an, ob der Datensatz ggf. überschrieben werden darf. Standard: true
Body Parameters
Das Model enthält sämtliche Eigenschaften der Unterschrift. Bleiben die Pflichtfelder leer, kann keine Unterschrift angelegt werden. Die Signatur-Id wird dann automatisch vergeben.
Id
integer
Primary index field database: [DOCUMENT_SIGNATURES].[DOCUMENT_SIGNATURES_ID].
Picture
Collection of byte
Erforderlich
Binary storage of the image as a byte array Database: [DOCUMENT_SIGNATURES].[Image].
DocumentType
string
Erforderlich
Länge: einschließlich zwischen 0 und 1
Document type of the signed document Database: [DOCUMENT_SIGNATURES].[DocumentType].
DocumentNumber
string
Erforderlich
Länge: einschließlich zwischen 0 und 10
Document number of the signed document Database: [DOCUMENT_SIGNATURES].[DocumentNumber].
TransferId
string
Länge: einschließlich zwischen 0 und 12
Link to the created transfer database: [DOCUMENT_SIGNATURES].[TransferID].
IsTemporary
boolean
True: As long as the transfer or service has not been taken over. Database: [DOCUMENT_SIGNATURES].[IsTemporary].
Signer
string
Länge: einschließlich zwischen 0 und 80
Optional plaintext of the signer Database: [DOCUMENT_SIGNATURES].[plainname].
MetaData
Clients for the data rate
Request Formats
application/json
Example:
{
"Id": 1,
"Picture": "QEA=",
"DocumentType": "sample string 2",
"DocumentNumber": "sample string 3",
"TransferId": "sample string 4",
"IsTemporary": true,
"Signer": "sample string 5",
"MetaData": {
"CreationDate": "2024-12-26T23:23:13.6848906+01:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-12-26T23:23:13.6848906+01:00",
"ModificationUserToken": "sample string 2"
}
}
Response
Resource Description
Ein HTTP Status Code 201 (Created) bestätigt das erfolgreiche Anlegen. Der Response Location Header enthält die Url der angelegten Unterschrift. Es wird kein Content geliefert.
SignatureId
integer
SignaturId
Response Formats
application/json
Example:
{
"SignatureId": 1
}