| POST | /Signature |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SignatureRequest:
file_id: int = 0
original_file_id: int = 0
workflow_id: int = 0
step_id: int = 0
sub_document_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicUploadedFile:
file_name: Optional[str] = None
filekey: Optional[str] = None
file_url: Optional[str] = None
checksum: Optional[str] = None
e_tag: Optional[str] = None
file_size: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadedFiles(BasicUploadedFile):
id: Optional[int] = None
uploaded_file: Optional[str] = None
sub_document_id: Optional[int] = None
step_id: Optional[int] = None
code: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentSignLog:
id: int = 0
document_id: int = 0
sub_document_id: Optional[int] = None
step_id: int = 0
file_id: int = 0
# @StringLength(50)
sign_provider: Optional[str] = None
# @StringLength(100)
cert_serial: Optional[str] = None
is_success: bool = False
# @StringLength(500)
sign_message: Optional[str] = None
sign_by: int = 0
sign_at: datetime.datetime = datetime.datetime(1, 1, 1)
request_id: Optional[str] = None
original_file_id: Optional[int] = None
effect_begin_date: Optional[datetime.datetime] = None
effect_end_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SignatureResponse(IResponseRequest):
code: int = 0
message: Optional[str] = None
signed_file: Optional[UploadedFiles] = None
sign_log: Optional[DocumentSignLog] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Signature HTTP/1.1
Host: etc-api.vsmlab.vn
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SignatureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
<FileId>0</FileId>
<OriginalFileId>0</OriginalFileId>
<StepId>0</StepId>
<SubDocumentId>0</SubDocumentId>
<WorkflowId>0</WorkflowId>
</SignatureRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SignatureResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
<Code>0</Code>
<Message>String</Message>
<SignLog xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:CertSerial>String</d2p1:CertSerial>
<d2p1:DocumentId>0</d2p1:DocumentId>
<d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
<d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
<d2p1:FileId>0</d2p1:FileId>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsSuccess>false</d2p1:IsSuccess>
<d2p1:OriginalFileId>0</d2p1:OriginalFileId>
<d2p1:RequestId>00000000-0000-0000-0000-000000000000</d2p1:RequestId>
<d2p1:SignAt>0001-01-01T00:00:00</d2p1:SignAt>
<d2p1:SignBy>0</d2p1:SignBy>
<d2p1:SignMessage>String</d2p1:SignMessage>
<d2p1:SignProvider>String</d2p1:SignProvider>
<d2p1:StepId>0</d2p1:StepId>
<d2p1:SubDocumentId>0</d2p1:SubDocumentId>
</SignLog>
<SignedFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:Checksum>String</d2p1:Checksum>
<d2p1:ETag>String</d2p1:ETag>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FileSize>0</d2p1:FileSize>
<d2p1:FileUrl>String</d2p1:FileUrl>
<d2p1:Filekey>String</d2p1:Filekey>
<d2p1:Code>0</d2p1:Code>
<d2p1:Id>0</d2p1:Id>
<d2p1:StepId>0</d2p1:StepId>
<d2p1:SubDocumentId>0</d2p1:SubDocumentId>
<d2p1:UploadedFile>String</d2p1:UploadedFile>
</SignedFile>
</SignatureResponse>