tvpl.api

GetTemplateByIdRequest

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceModel
Imports tvpl.data.Models

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class DocumentElementDto
            Inherits DocumentElement
            Public Sub New()
                Children = New List(Of DocumentElementDto)
            End Sub

            Public Overridable Property Children As List(Of DocumentElementDto)
        End Class

        Public Partial Class DocumentTemplateDto
            Inherits DocumentTemplate
            Public Sub New()
                Elements = New List(Of DocumentElementDto)
            End Sub

            Public Overridable Property Elements As List(Of DocumentElementDto)
        End Class

        Public Partial Class DocumentTemplateResponse
            Public Overridable Property Template As DocumentTemplateDto
            Public Overridable Property InsertedId As Integer
            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class GetTemplateByIdRequest
            Public Overridable Property Id As Integer
        End Class
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class DocumentElement
            Public Overridable Property Id As Integer
            Public Overridable Property TemplateId As Integer
            <Required>
            Public Overridable Property ElementKey As String

            <Required>
            Public Overridable Property Tag As String

            Public Overridable Property ParentId As Nullable(Of Integer)
            <Required>
            Public Overridable Property Title As String

            Public Overridable Property Description As String
            <Required>
            Public Overridable Property DataType As String

            Public Overridable Property TemplateType As String
            Public Overridable Property OrderIndex As Integer
            Public Overridable Property IsRequired As Nullable(Of Boolean)
        End Class

        Public Partial Class DocumentTemplate
            Public Overridable Property Id As Integer
            <Required>
            Public Overridable Property Title As String

            Public Overridable Property Description As String
            Public Overridable Property IsActive As Boolean
            Public Overridable Property FileKey As String
            Public Overridable Property FileUrl As String
            Public Overridable Property FileName As String
            Public Overridable Property FileSize As Nullable(Of Long)
        End Class
    End Namespace
End Namespace

VB.NET GetTemplateByIdRequest 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 HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}