| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
fileId: 0,
originalFileId: 0,
workflowId: 0,
stepId: 0,
subDocumentId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
code: 0,
message: String,
signedFile:
{
id: 0,
uploadedFile: String,
subDocumentId: 0,
stepId: 0,
code: 0,
fileName: String,
filekey: String,
fileUrl: String,
checksum: String,
eTag: String,
fileSize: 0
},
signLog:
{
id: 0,
documentId: 0,
subDocumentId: 0,
stepId: 0,
fileId: 0,
signProvider: String,
certSerial: String,
isSuccess: False,
signMessage: String,
signBy: 0,
requestId: 00000000000000000000000000000000,
originalFileId: 0,
effectBeginDate: "0001-01-01T00:00:00.0000000+07:06",
effectEndDate: "0001-01-01T00:00:00.0000000+07:06"
}
}