tvpl.api

SignatureRequest

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceModel
Imports tvpl.data.Models

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class SignatureRequest
            Public Overridable Property FileId As Integer
            Public Overridable Property OriginalFileId As Integer
            Public Overridable Property WorkflowId As Integer
            Public Overridable Property StepId As Integer
            Public Overridable Property SubDocumentId As Integer
        End Class

        Public Partial Class SignatureResponse
            Implements IResponseRequest
            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
            Public Overridable Property SignedFile As UploadedFiles
            Public Overridable Property SignLog As DocumentSignLog
        End Class
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class BasicUploadedFile
            Public Overridable Property FileName As String
            Public Overridable Property Filekey As String
            Public Overridable Property FileUrl As String
            Public Overridable Property Checksum As String
            Public Overridable Property ETag As String
            Public Overridable Property FileSize As Long
        End Class

        Public Partial Class DocumentSignLog
            Public Overridable Property Id As Long
            Public Overridable Property DocumentId As Long
            Public Overridable Property SubDocumentId As Nullable(Of Long)
            Public Overridable Property StepId As Integer
            Public Overridable Property FileId As Long
            <StringLength(50)>
            Public Overridable Property SignProvider As String

            <StringLength(100)>
            Public Overridable Property CertSerial As String

            Public Overridable Property IsSuccess As Boolean
            <StringLength(500)>
            Public Overridable Property SignMessage As String

            Public Overridable Property SignBy As Long
            Public Overridable Property SignAt As Date
            Public Overridable Property RequestId As Nullable(Of Guid)
            Public Overridable Property OriginalFileId As Nullable(Of Integer)
            Public Overridable Property EffectBeginDate As Nullable(Of Date)
            Public Overridable Property EffectEndDate As Nullable(Of Date)
        End Class

        Public Partial Class UploadedFiles
            Inherits BasicUploadedFile
            Public Overridable Property Id As Nullable(Of Long)
            Public Overridable Property UploadedFile As String
            Public Overridable Property SubDocumentId As Nullable(Of Integer)
            Public Overridable Property StepId As Nullable(Of Integer)
            Public Overridable Property Code As Integer
        End Class
    End Namespace
End Namespace

VB.NET SignatureRequest DTOs

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>