tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search
namespace tvpl.api.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BasicDocument() = 
        [<Required>]
        member val Title:String = null with get,set

        [<StringLength(4000)>]
        member val Description:String = null with get,set

        [<StringLength(500)>]
        member val Owner:String = null with get,set

        member val DocumentPolicyId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UpdateDocumentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EffectBeginDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EffectEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IssuingAgencyId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DocumentTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DocumentGroupId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SubjectId:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<StringLength(500)>]
        member val SignBy:String = null with get,set

        member val SignDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StatusId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsInternal:Boolean = new Boolean() with get,set
        member val DocumentNumber:String = null with get,set
        member val DocumentCode:String = null with get,set
        member val IsUrgent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ScopeType:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsActive:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type Document() = 
        inherit BasicDocument()
        member val Id:Int32 = new Int32() with get,set
        [<StringLength(500)>]
        member val ReasonReturn:String = null with get,set

        member val AccountId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DeletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        [<StringLength(500)>]
        member val DeletedBy:String = null with get,set

        [<StringLength(500)>]
        member val UpdatedBy:String = null with get,set

        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        [<StringLength(500)>]
        member val CreatedBy:String = null with get,set

        member val IsParty:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val IsRevisionRequested:Boolean = new Boolean() with get,set
        member val LastUpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsPrivate:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DepartmentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PublicationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ProcessStatusId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FullTextSearchContent:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentTemplate() = 
        member val Id:Int32 = new Int32() with get,set
        [<Required>]
        member val Title:String = null with get,set

        member val Description:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        [<Ignore>]
        member val DocumentIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

        [<Ignore>]
        member val Documents:ResizeArray<Document> = new ResizeArray<Document>() with get,set

    [<AllowNullLiteral>]
    type SearchDocumentTemplateResponse() = 
        member val Code:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val Data:ResizeArray<DocumentTemplate> = new ResizeArray<DocumentTemplate>() with get,set
        member val TotalCount:Int64 = new Int64() with get,set

    [<AllowNullLiteral>]
    type PagingRequest() = 
        member val Page:Int32 = new Int32() with get,set
        member val Limit:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SearchTemplateRequest() = 
        inherit PagingRequest()
        member val Title:String = null with get,set

F# 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
}