tvpl.api

SignatureRequest

The following routes are available for this service:
POST	/Signature

**SignatureRequest** Parameters:
Name	Parameter	Data Type	Required
FileId	body	int	No
OriginalFileId	body	int	No
WorkflowId	body	int	No
StepId	body	int	No
SubDocumentId	body	int	No

**SignatureResponse** Parameters:
Name	Parameter	Data Type	Required
Code	form	int	No
Message	form	string	Yes
SignedFile	form	UploadedFiles	No
SignLog	form	DocumentSignLog	No

**UploadedFiles** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
UploadedFile	form	string	Yes
SubDocumentId	form	int?	No
StepId	form	int?	No
Code	form	int	No

**BasicUploadedFile** Parameters:
Name	Parameter	Data Type	Required
FileName	form	string	Yes
Filekey	form	string	Yes
FileUrl	form	string	Yes
Checksum	form	string	Yes
ETag	form	string	Yes
FileSize	form	long	No

**DocumentSignLog** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
DocumentId	form	long	No
SubDocumentId	form	long?	No
StepId	form	int	No
FileId	form	long	No
SignProvider	form	string	No
CertSerial	form	string	No
IsSuccess	form	bool	No
SignMessage	form	string	No
SignBy	form	long	No
SignAt	form	DateTime	No
RequestId	form	Guid?	No
OriginalFileId	form	int?	No
EffectBeginDate	form	DateTime?	No
EffectEndDate	form	DateTime?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>