tvpl.api

GetTemplateByIdRequest

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


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 DocumentElement
{
    public id: number;
    public templateId: number;
    // @Required()
    public elementKey: string;

    // @Required()
    public tag: string;

    public parentId?: number;
    // @Required()
    public title: string;

    public description?: string;
    // @Required()
    public dataType: string;

    public templateType?: string;
    public orderIndex: number;
    public isRequired?: boolean;

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

export class DocumentElementDto extends DocumentElement
{
    public children: DocumentElementDto[];

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

export class DocumentTemplateDto extends DocumentTemplate
{
    public elements?: DocumentElementDto[];

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

export class DocumentTemplateResponse
{
    public template?: DocumentTemplateDto;
    public insertedId: number;
    public code: number;
    public message?: string;

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

export class GetTemplateByIdRequest
{
    public id: number;

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

TypeScript GetTemplateByIdRequest 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.

GET /document-template HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	template: 
	{
		elements: 
		[
			{
				children: 
				[
					{
						children: 
						[
							{
								id: 0,
								templateId: 0,
								elementKey: String,
								tag: String,
								parentId: 0,
								title: String,
								description: String,
								dataType: String,
								templateType: String,
								orderIndex: 0,
								isRequired: False
							}
						],
						id: 0,
						templateId: 0,
						elementKey: String,
						tag: String,
						parentId: 0,
						title: String,
						description: String,
						dataType: String,
						templateType: String,
						orderIndex: 0,
						isRequired: False
					}
				],
				id: 0,
				templateId: 0,
				elementKey: String,
				tag: String,
				parentId: 0,
				title: String,
				description: String,
				dataType: String,
				templateType: String,
				orderIndex: 0,
				isRequired: False
			}
		],
		id: 0,
		title: String,
		description: String,
		isActive: False,
		fileKey: String,
		fileUrl: String,
		fileName: String,
		fileSize: 0
	},
	insertedId: 0,
	code: 0,
	message: String
}