tvpl.api

<back to all web services

SignatureRequest

export class SignatureRequest
{
    public fileId: number;
    public originalFileId: number;
    public workflowId: number;
    public stepId: number;
    public subDocumentId: number;

    public constructor(init?: Partial<SignatureRequest>) { (Object as any).assign(this, init); }
}

export class BasicUploadedFile
{
    public fileName: string;
    public filekey: string;
    public fileUrl: string;
    public checksum: string;
    public eTag: string;
    public fileSize: number;

    public constructor(init?: Partial<BasicUploadedFile>) { (Object as any).assign(this, init); }
}

export class UploadedFiles extends BasicUploadedFile
{
    public id?: number;
    public uploadedFile: string;
    public subDocumentId?: number;
    public stepId?: number;
    public code: number;

    public constructor(init?: Partial<UploadedFiles>) { super(init); (Object as any).assign(this, init); }
}

export class DocumentSignLog
{
    public id: number;
    public documentId: number;
    public subDocumentId?: number;
    public stepId: number;
    public fileId: number;
    // @StringLength(50)
    public signProvider?: string;

    // @StringLength(100)
    public certSerial?: string;

    public isSuccess: boolean;
    // @StringLength(500)
    public signMessage?: string;

    public signBy: number;
    public signAt: string;
    public requestId?: string;
    public originalFileId?: number;
    public effectBeginDate?: string;
    public effectEndDate?: string;

    public constructor(init?: Partial<DocumentSignLog>) { (Object as any).assign(this, init); }
}

export class SignatureResponse implements IResponseRequest
{
    public code: number;
    public message: string;
    public signedFile?: UploadedFiles;
    public signLog?: DocumentSignLog;

    public constructor(init?: Partial<SignatureResponse>) { (Object as any).assign(this, init); }
}

TypeScript SignatureRequest DTOs

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>