tvpl.api

SignatureRequest

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

import Foundation
import ServiceStack

public class SignatureRequest : Codable
{
    public var fileId:Int
    public var originalFileId:Int
    public var workflowId:Int
    public var stepId:Int
    public var subDocumentId:Int

    required public init(){}
}

public class SignatureResponse : IResponseRequest, Codable
{
    public var code:Int
    public var message:String
    public var signedFile:UploadedFiles
    public var signLog:DocumentSignLog

    required public init(){}
}

public class UploadedFiles : BasicUploadedFile
{
    public var id:Int?
    public var uploadedFile:String
    public var subDocumentId:Int?
    public var stepId:Int?
    public var code:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case uploadedFile
        case subDocumentId
        case stepId
        case code
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        uploadedFile = try container.decodeIfPresent(String.self, forKey: .uploadedFile)
        subDocumentId = try container.decodeIfPresent(Int.self, forKey: .subDocumentId)
        stepId = try container.decodeIfPresent(Int.self, forKey: .stepId)
        code = try container.decodeIfPresent(Int.self, forKey: .code)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if uploadedFile != nil { try container.encode(uploadedFile, forKey: .uploadedFile) }
        if subDocumentId != nil { try container.encode(subDocumentId, forKey: .subDocumentId) }
        if stepId != nil { try container.encode(stepId, forKey: .stepId) }
        if code != nil { try container.encode(code, forKey: .code) }
    }
}

public class BasicUploadedFile : Codable
{
    public var fileName:String
    public var filekey:String
    public var fileUrl:String
    public var checksum:String
    public var eTag:String
    public var fileSize:Int

    required public init(){}
}

public class DocumentSignLog : Codable
{
    public var id:Int
    public var documentId:Int
    public var subDocumentId:Int?
    public var stepId:Int
    public var fileId:Int
    // @StringLength(50)
    public var signProvider:String

    // @StringLength(100)
    public var certSerial:String

    public var isSuccess:Bool
    // @StringLength(500)
    public var signMessage:String

    public var signBy:Int
    public var signAt:Date
    public var requestId:String?
    public var originalFileId:Int?
    public var effectBeginDate:Date?
    public var effectEndDate:Date?

    required public init(){}
}

Swift SignatureRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"fileId":0,"originalFileId":0,"workflowId":0,"stepId":0,"subDocumentId":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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,"signAt":"0001-01-01T00:00:00.0000000+07:06","requestId":"00000000000000000000000000000000","originalFileId":0,"effectBeginDate":"0001-01-01T00:00:00.0000000+07:06","effectEndDate":"0001-01-01T00:00:00.0000000+07:06"}}