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
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 CreateDocumentTemplateResponse
            Implements IResponseRequest
            Public Overridable Property InsertedId As Integer
            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class CreateOrUpdateTemplateRequest
            Public Sub New()
                DocumentIds = New List(Of Integer)
                Elements = New List(Of DocumentElementDto)
            End Sub

            Public Overridable Property Id As Nullable(Of Integer)
            Public Overridable Property DocumentIds As List(Of Integer)
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property IsActive As Boolean
            Public Overridable Property Elements As List(Of DocumentElementDto)
        End Class

        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
    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
    End Namespace
End Namespace

VB.NET CreateOrUpdateTemplateRequest 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.

POST /document-template HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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