tvpl.api

DocumentSearchRequest

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Limit>10</Limit>
  <Page>1</Page>
  <DocumentSearchStage>All</DocumentSearchStage>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <GroupId>0</GroupId>
  <IsInternal>false</IsInternal>
  <IsParty>false</IsParty>
  <IsUrgent>false</IsUrgent>
  <IssuingAgencyId>0</IssuingAgencyId>
  <OrderBy>UpdatedDateDesc</OrderBy>
  <ScopeType>0</ScopeType>
  <StatusId>0</StatusId>
  <SubjectId>0</SubjectId>
  <Title>String</Title>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <TypeId>0</TypeId>
</DocumentSearchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:DocumentSearchResultItem>
      <d2p1:AcceptAccountName>String</d2p1:AcceptAccountName>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:ApproverId>0</d2p1:ApproverId>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:CreatedBy>String</d2p1:CreatedBy>
      <d2p1:DepartmentId>0</d2p1:DepartmentId>
      <d2p1:DepartmentText>String</d2p1:DepartmentText>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DocumentCode>String</d2p1:DocumentCode>
      <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
      <d2p1:DocumentGroupText>String</d2p1:DocumentGroupText>
      <d2p1:DocumentNumber>String</d2p1:DocumentNumber>
      <d2p1:DocumentPolicyId>0</d2p1:DocumentPolicyId>
      <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
      <d2p1:DocumentTypeText>String</d2p1:DocumentTypeText>
      <d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
      <d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
      <d2p1:FullFile>String</d2p1:FullFile>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsInternal>false</d2p1:IsInternal>
      <d2p1:IsParty>false</d2p1:IsParty>
      <d2p1:IsPrivate>false</d2p1:IsPrivate>
      <d2p1:IsRevisionRequested>false</d2p1:IsRevisionRequested>
      <d2p1:IsUrgent>false</d2p1:IsUrgent>
      <d2p1:IssuingAgencyId>0</d2p1:IssuingAgencyId>
      <d2p1:IssuingAgencyText>String</d2p1:IssuingAgencyText>
      <d2p1:Owner>String</d2p1:Owner>
      <d2p1:ParthFile>String</d2p1:ParthFile>
      <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
      <d2p1:ProcessStatusText>String</d2p1:ProcessStatusText>
      <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
      <d2p1:ReasonReturn>String</d2p1:ReasonReturn>
      <d2p1:SignBy>String</d2p1:SignBy>
      <d2p1:SignDate>0001-01-01T00:00:00</d2p1:SignDate>
      <d2p1:StatusId>0</d2p1:StatusId>
      <d2p1:StatusText>String</d2p1:StatusText>
      <d2p1:StepCount>0</d2p1:StepCount>
      <d2p1:StepOrder>0</d2p1:StepOrder>
      <d2p1:SubjectId>0</d2p1:SubjectId>
      <d2p1:SubjectText>String</d2p1:SubjectText>
      <d2p1:SubmitComment>String</d2p1:SubmitComment>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdateDocumentId>0</d2p1:UpdateDocumentId>
      <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
      <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
    </d2p1:DocumentSearchResultItem>
  </Data>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
</SearchResponse>