tvpl.api

<back to all web services

SearchTemplateRequest

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


open class SearchTemplateRequest : PagingRequest()
{
    var title:String? = null
}

open class PagingRequest
{
    var page:Int? = null
    var limit:Int? = null
}

open class SearchDocumentTemplateResponse : IResponseRequest
{
    var code:Int? = null
    var message:String? = null
    @SerializedName("data") var Data:ArrayList<DocumentTemplate> = ArrayList<DocumentTemplate>()
    var totalCount:Long? = null
}

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

    var description:String? = null
    var isActive:Boolean? = null
    @Ignore()
    var documentIds:ArrayList<Int> = ArrayList<Int>()

    @Ignore()
    var documents:ArrayList<Document> = ArrayList<Document>()
}

open class Document : BasicDocument()
{
    var id:Int? = null
    @StringLength(500)
    var reasonReturn:String? = null

    var accountId:Int? = null
    var deletedAt:Date? = null
    @StringLength(500)
    var deletedBy:String? = null

    @StringLength(500)
    var updatedBy:String? = null

    var createdAt:Date? = null
    @StringLength(500)
    var createdBy:String? = null

    var isParty:Boolean? = null
    var isRevisionRequested:Boolean? = null
    var lastUpdatedAt:Date? = null
    var isPrivate:Boolean? = null
    var departmentId:Int? = null
    var publicationDate:Date? = null
    var processStatusId:Int? = null
    var fullTextSearchContent:String? = null
}

open class BasicDocument
{
    @Required()
    var title:String? = null

    @StringLength(4000)
    var description:String? = null

    @StringLength(500)
    var owner:String? = null

    var documentPolicyId:Int? = null
    var updateDocumentId:Int? = null
    var effectBeginDate:Date? = null
    var effectEndDate:Date? = null
    var issuingAgencyId:Int? = null
    var documentTypeId:Int? = null
    var documentGroupId:Int? = null
    var subjectId:Int? = null
    @StringLength(500)
    var signBy:String? = null

    var signDate:Date? = null
    var statusId:Int? = null
    var isInternal:Boolean? = null
    var documentNumber:String? = null
    var documentCode:String? = null
    var isUrgent:Boolean? = null
    var scopeType:Int? = null
    var isActive:Boolean? = null
}

Kotlin 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: etc-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,
			documentIds: 
			[
				0
			],
			documents: 
			[
				{
					id: 0,
					reasonReturn: String,
					accountId: 0,
					deletedAt: "0001-01-01T00:00:00.0000000+07:06",
					deletedBy: String,
					updatedBy: String,
					createdAt: "0001-01-01T00:00:00.0000000+07:06",
					createdBy: String,
					isParty: False,
					isRevisionRequested: False,
					lastUpdatedAt: "0001-01-01T00:00:00.0000000+07:06",
					isPrivate: False,
					departmentId: 0,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06",
					processStatusId: 0,
					fullTextSearchContent: String,
					title: String,
					description: String,
					owner: String,
					documentPolicyId: 0,
					updateDocumentId: 0,
					effectBeginDate: "0001-01-01T00:00:00.0000000+07:06",
					effectEndDate: "0001-01-01T00:00:00.0000000+07:06",
					issuingAgencyId: 0,
					documentTypeId: 0,
					documentGroupId: 0,
					subjectId: 0,
					signBy: String,
					signDate: "0001-01-01T00:00:00.0000000+07:06",
					statusId: 0,
					isInternal: False,
					documentNumber: String,
					documentCode: String,
					isUrgent: False,
					scopeType: 0,
					isActive: False
				}
			]
		}
	],
	totalCount: 0
}