tvpl.api

<back to all web services

GetTemplateByIdRequest

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


open class GetTemplateByIdRequest
{
    var id:Int? = null
}

open class DocumentTemplateResponse
{
    var template:DocumentTemplateDto? = null
    var insertedId:Int? = null
    var code:Int? = null
    var message:String? = null
}

open class DocumentTemplateDto : DocumentTemplate()
{
    var elements:ArrayList<DocumentElementDto> = ArrayList<DocumentElementDto>()
}

open class DocumentTemplate
{
    var id:Int? = null
    @Required()
    var title:String? = null

    var description:String? = null
    var isActive:Boolean? = null
    var fileKey:String? = null
    var fileUrl:String? = null
    var fileName:String? = null
    var fileSize:Long? = null
}

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
}

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

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

{"template":{"elements":[{"children":[{"children":[{"children":null,"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"}