tvpl.api

<back to all web services

CreateOrUpdateTemplateRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/document-template
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateOrUpdateTemplateRequest
{
    var id:Int? = null
    var documentIds:ArrayList<Int> = ArrayList<Int>()
    var title:String? = null
    var description:String? = null
    var isActive:Boolean? = null
    var elements:ArrayList<DocumentElementDto> = ArrayList<DocumentElementDto>()
}

open class DocumentElementDto : DocumentElement()
{
    var children:ArrayList<DocumentElementDto> = ArrayList<DocumentElementDto>()
}

open class DocumentElement
{
    var id:Int? = null
    var templateId:Int? = null
    @Required()
    var elementKey:String? = null

    @Required()
    var tag:String? = null

    var parentId:Int? = null
    @Required()
    var title:String? = null

    var description:String? = null
    @Required()
    var dataType:String? = null

    var templateType:String? = null
    var orderIndex:Int? = null
    var isRequired:Boolean? = null
}

open class CreateDocumentTemplateResponse : IResponseRequest
{
    var insertedId:Int? = null
    var code:Int? = null
    var message:String? = null
}

Kotlin CreateOrUpdateTemplateRequest 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 /document-template HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	documentIds: 
	[
		0
	],
	title: String,
	description: String,
	isActive: False,
	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
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	insertedId: 0,
	code: 0,
	message: String
}