tvpl.api

<back to all web services

DocumentSearchRequest

Requires Authentication
The following routes are available for this service:
POST/document/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 DocumentSearchResultItem() = 
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        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 SubjectId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SignBy:String = null with get,set
        member val SignDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt: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 Id:Int32 = new Int32() with get,set
        member val ReasonReturn:String = null with get,set
        member val AccountId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ApproverId:Nullable<Int32> = new Nullable<Int32>() with get,set
        [<StringLength(500)>]
        member val UpdatedBy:String = null 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:Nullable<Boolean> = new Nullable<Boolean>() 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:Int32 = new 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 AccountName:String = null with get,set
        member val AcceptAccountName:String = null with get,set
        member val DocumentGroupText:String = null with get,set
        member val ProcessStatusText:String = null with get,set
        member val DocumentTypeText:String = null with get,set
        member val DepartmentText:String = null with get,set
        member val StatusText:String = null with get,set
        member val IssuingAgencyText:String = null with get,set
        member val SubjectText:String = null with get,set
        member val Comment:String = null with get,set
        member val SubmitComment:String = null with get,set
        member val FullFile:String = null with get,set
        member val ParthFile:String = null with get,set
        member val IsActive:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val StepOrder:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val StepCount:Nullable<Int32> = new Nullable<Int32>() with get,set

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

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

    type DocumentSearchStage =
        | All = 0
        | AllProcessing = 1
        | Draft = 2
        | PendingApproval = 3
        | IsRevisionRequested = 4
        | PendingCompilation = 5
        | PendingReport = 6
        | Published = 7
        | Active = 8
        | InActive = 9

    type SearchOrderBy =
        | UpdatedDateDesc = 0
        | PublishDateDesc = 1

    [<AllowNullLiteral>]
    type DocumentSearchRequest() = 
        inherit PagingRequest()
        interface IPost
        member val Title:String = null with get,set
        member val TypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val GroupId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SubjectId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IssuingAgencyId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsUrgent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DocumentSearchStage:DocumentSearchStage = new DocumentSearchStage() with get,set
        member val IsInternal:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val StatusId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OrderBy:SearchOrderBy = new SearchOrderBy() with get,set
        member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val IsParty:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ScopeType:Int32 = new Int32() with get,set

F# DocumentSearchRequest 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.

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

{
	title: String,
	typeId: 0,
	groupId: 0,
	subjectId: 0,
	issuingAgencyId: 0,
	isUrgent: False,
	documentSearchStage: All,
	isInternal: False,
	statusId: 0,
	orderBy: UpdatedDateDesc,
	fromDate: "0001-01-01T00:00:00.0000000+07:06",
	toDate: "0001-01-01T00:00:00.0000000+07:06",
	isParty: False,
	scopeType: 0,
	page: 1,
	limit: 10
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalCount: 0,
	code: 0,
	data: 
	[
		{
			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,
			subjectId: 0,
			signBy: String,
			signDate: "0001-01-01T00:00:00.0000000+07:06",
			updatedAt: "0001-01-01T00:00:00.0000000+07:06",
			statusId: 0,
			isInternal: False,
			documentNumber: String,
			documentCode: String,
			isUrgent: False,
			id: 0,
			reasonReturn: String,
			accountId: 0,
			approverId: 0,
			updatedBy: String,
			createdBy: String,
			isParty: False,
			isRevisionRequested: False,
			isPrivate: False,
			departmentId: 0,
			publicationDate: "0001-01-01T00:00:00.0000000+07:06",
			processStatusId: 0,
			documentTypeId: 0,
			documentGroupId: 0,
			accountName: String,
			acceptAccountName: String,
			documentGroupText: String,
			processStatusText: String,
			documentTypeText: String,
			departmentText: String,
			statusText: String,
			issuingAgencyText: String,
			subjectText: String,
			comment: String,
			submitComment: String,
			fullFile: String,
			parthFile: String,
			isActive: False,
			stepOrder: 0,
			stepCount: 0
		}
	],
	message: String
}