tvpl.api

<back to all web services

SignatureRequest

Requires Authentication
The following routes are available for this service:
POST/Signature
namespace tvpl.api.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SignatureRequest() = 
        member val FileId:Int32 = new Int32() with get,set
        member val OriginalFileId:Int32 = new Int32() with get,set
        member val WorkflowId:Int32 = new Int32() with get,set
        member val StepId:Int32 = new Int32() with get,set
        member val SubDocumentId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BasicUploadedFile() = 
        member val FileName:String = null with get,set
        member val Filekey:String = null with get,set
        member val FileUrl:String = null with get,set
        member val Checksum:String = null with get,set
        member val ETag:String = null with get,set
        member val FileSize:Int64 = new Int64() with get,set

    [<AllowNullLiteral>]
    type UploadedFiles() = 
        inherit BasicUploadedFile()
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val UploadedFile:String = null with get,set
        member val SubDocumentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StepId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Code:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DocumentSignLog() = 
        member val Id:Int64 = new Int64() with get,set
        member val DocumentId:Int64 = new Int64() with get,set
        member val SubDocumentId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val StepId:Int32 = new Int32() with get,set
        member val FileId:Int64 = new Int64() with get,set
        [<StringLength(50)>]
        member val SignProvider:String = null with get,set

        [<StringLength(100)>]
        member val CertSerial:String = null with get,set

        member val IsSuccess:Boolean = new Boolean() with get,set
        [<StringLength(500)>]
        member val SignMessage:String = null with get,set

        member val SignBy:Int64 = new Int64() with get,set
        member val SignAt:DateTime = new DateTime() with get,set
        member val RequestId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val OriginalFileId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EffectBeginDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EffectEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type SignatureResponse() = 
        member val Code:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val SignedFile:UploadedFiles = null with get,set
        member val SignLog:DocumentSignLog = null with get,set

F# SignatureRequest DTOs

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

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