tvpl.api

ReportSearch

The following routes are available for this service:
POST	/report/search

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ReportSearch : PagingRequest()
{
    var columns:ArrayList<String> = ArrayList<String>()
    var title:String? = null
    var typeId:Int? = null
    var groupId:Int? = null
    var subjectId:Int? = null
    var isUrgent:Boolean? = null
    var documentSearchStage:DocumentSearchStage? = null
    var isInternal:Boolean? = null
    var fromDate:Date? = null
    var toDate:Date? = null
    var statusId:Int? = null
    var issuingAgencyId:Int? = null
    var orderBy:SearchOrderBy? = null
    var isParty:Boolean? = null
}

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

enum class DocumentSearchStage
{
    All,
    AllProcessing,
    Draft,
    PendingApproval,
    IsRevisionRequested,
    PendingCompilation,
    PendingReport,
    Published,
    Active,
    InActive,
}

enum class SearchOrderBy
{
    UpdatedDateDesc,
    PublishDateDesc,
}

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

open class DocumentSearchResultItem
{
    var title:String? = null
    var description:String? = null
    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 subjectId:Int? = null
    var signBy:String? = null
    var signDate:Date? = null
    var updatedAt:Date? = null
    var statusId:Int? = null
    var isInternal:Boolean? = null
    var documentNumber:String? = null
    var documentCode:String? = null
    var isUrgent:Boolean? = null
    var id:Int? = null
    var reasonReturn:String? = null
    var accountId:Int? = null
    var approverId:Int? = null
    @StringLength(500)
    var updatedBy:String? = null

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

    var isParty:Boolean? = null
    var isRevisionRequested:Boolean? = null
    var isPrivate:Boolean? = null
    var departmentId:Int? = null
    var publicationDate:Date? = null
    var processStatusId:Int? = null
    var documentTypeId:Int? = null
    var documentGroupId:Int? = null
    var accountName:String? = null
    var acceptAccountName:String? = null
    var documentGroupText:String? = null
    var processStatusText:String? = null
    var documentTypeText:String? = null
    var departmentText:String? = null
    var statusText:String? = null
    var issuingAgencyText:String? = null
    var subjectText:String? = null
    var comment:String? = null
    var submitComment:String? = null
    var fullFile:String? = null
    var parthFile:String? = null
    var isActive:Boolean? = null
    var stepOrder:Int? = null
    var stepCount:Int? = null
}

Kotlin ReportSearch 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 /report/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReportSearch 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>
  <Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Columns>
  <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>
  <StatusId>0</StatusId>
  <SubjectId>0</SubjectId>
  <Title>String</Title>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <TypeId>0</TypeId>
</ReportSearch>

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>