tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search
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 PagingRequest
            Public Overridable Property Page As Integer
            Public Overridable Property Limit As Integer
        End Class

        Public Partial Class SearchDocumentTemplateResponse
            Implements IResponseRequest
            Public Sub New()
                Data = New List(Of DocumentTemplate)
            End Sub

            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
            Public Overridable Property Data As List(Of DocumentTemplate)
            Public Overridable Property TotalCount As Long
        End Class

        Public Partial Class SearchTemplateRequest
            Inherits PagingRequest
            Public Overridable Property Title As String
            Public Overridable Property IsActive As Nullable(Of Boolean)
        End Class
    End Namespace

    Namespace tvpl.data.Models

        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 SearchTemplateRequest 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/search HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			id: 0,
			title: String,
			description: String,
			isActive: False,
			fileKey: String,
			fileUrl: String,
			fileName: String,
			fileSize: 0
		}
	],
	totalCount: 0
}