tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search

export class PagingRequest
{
    public page: number;
    public limit: number;

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

export class DocumentTemplate
{
    public id: number;
    // @Required()
    public title: string;

    public description?: string;
    public isActive: boolean;
    public fileKey?: string;
    public fileUrl?: string;
    public fileName?: string;
    public fileSize?: number;

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

export class SearchDocumentTemplateResponse implements IResponseRequest
{
    public code: number;
    public message: string;
    public data?: DocumentTemplate[];
    public totalCount: number;

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

export class SearchTemplateRequest extends PagingRequest
{
    public title?: string;
    public isActive?: boolean;

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

TypeScript SearchTemplateRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /document-template/search HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"code":0,"message":"String","data":[{"id":0,"title":"String","description":"String","isActive":false,"fileKey":"String","fileUrl":"String","fileName":"String","fileSize":0}],"totalCount":0}