tvpl.api

<back to all web services

ReportSearch

Requires Authentication
The following routes are available for this service:
POST/report/search
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class ReportSearch extends PagingRequest
    {
        public ArrayList<String> columns = null;
        public String title = null;
        public Integer typeId = null;
        public Integer groupId = null;
        public Integer subjectId = null;
        public Boolean isUrgent = null;
        public DocumentSearchStage documentSearchStage = null;
        public Boolean isInternal = null;
        public Date fromDate = null;
        public Date toDate = null;
        public Integer statusId = null;
        public Integer issuingAgencyId = null;
        public SearchOrderBy orderBy = null;
        public Boolean isParty = null;
        
        public ArrayList<String> getColumns() { return columns; }
        public ReportSearch setColumns(ArrayList<String> value) { this.columns = value; return this; }
        public String getTitle() { return title; }
        public ReportSearch setTitle(String value) { this.title = value; return this; }
        public Integer getTypeId() { return typeId; }
        public ReportSearch setTypeId(Integer value) { this.typeId = value; return this; }
        public Integer getGroupId() { return groupId; }
        public ReportSearch setGroupId(Integer value) { this.groupId = value; return this; }
        public Integer getSubjectId() { return subjectId; }
        public ReportSearch setSubjectId(Integer value) { this.subjectId = value; return this; }
        public Boolean getIsUrgent() { return isUrgent; }
        public ReportSearch setIsUrgent(Boolean value) { this.isUrgent = value; return this; }
        public DocumentSearchStage getDocumentSearchStage() { return documentSearchStage; }
        public ReportSearch setDocumentSearchStage(DocumentSearchStage value) { this.documentSearchStage = value; return this; }
        public Boolean getIsInternal() { return isInternal; }
        public ReportSearch setIsInternal(Boolean value) { this.isInternal = value; return this; }
        public Date getFromDate() { return fromDate; }
        public ReportSearch setFromDate(Date value) { this.fromDate = value; return this; }
        public Date getToDate() { return toDate; }
        public ReportSearch setToDate(Date value) { this.toDate = value; return this; }
        public Integer getStatusId() { return statusId; }
        public ReportSearch setStatusId(Integer value) { this.statusId = value; return this; }
        public Integer getIssuingAgencyId() { return issuingAgencyId; }
        public ReportSearch setIssuingAgencyId(Integer value) { this.issuingAgencyId = value; return this; }
        public SearchOrderBy getOrderBy() { return orderBy; }
        public ReportSearch setOrderBy(SearchOrderBy value) { this.orderBy = value; return this; }
        public Boolean getIsParty() { return isParty; }
        public ReportSearch setIsParty(Boolean value) { this.isParty = value; return this; }
    }

    public static class PagingRequest
    {
        public Integer page = null;
        public Integer limit = null;
        
        public Integer getPage() { return page; }
        public PagingRequest setPage(Integer value) { this.page = value; return this; }
        public Integer getLimit() { return limit; }
        public PagingRequest setLimit(Integer value) { this.limit = value; return this; }
    }

    public static enum DocumentSearchStage
    {
        All,
        AllProcessing,
        Draft,
        PendingApproval,
        IsRevisionRequested,
        PendingCompilation,
        PendingReport,
        Published,
        Active,
        InActive;
    }

    public static enum SearchOrderBy
    {
        UpdatedDateDesc,
        PublishDateDesc;
    }

    public static class SearchResponse implements IResponseRequest
    {
        public Long totalCount = null;
        public Integer code = null;
        public ArrayList<DocumentSearchResultItem> data = null;
        public String message = null;
        
        public Long getTotalCount() { return totalCount; }
        public SearchResponse setTotalCount(Long value) { this.totalCount = value; return this; }
        public Integer getCode() { return code; }
        public SearchResponse setCode(Integer value) { this.code = value; return this; }
        public ArrayList<DocumentSearchResultItem> getData() { return data; }
        public SearchResponse setData(ArrayList<DocumentSearchResultItem> value) { this.data = value; return this; }
        public String getMessage() { return message; }
        public SearchResponse setMessage(String value) { this.message = value; return this; }
    }

    public static class DocumentSearchResultItem
    {
        public String title = null;
        public String description = null;
        public String owner = null;
        public Integer documentPolicyId = null;
        public Integer updateDocumentId = null;
        public Date effectBeginDate = null;
        public Date effectEndDate = null;
        public Integer issuingAgencyId = null;
        public Integer subjectId = null;
        public String signBy = null;
        public Date signDate = null;
        public Date updatedAt = null;
        public Integer statusId = null;
        public Boolean isInternal = null;
        public String documentNumber = null;
        public String documentCode = null;
        public Boolean isUrgent = null;
        public Integer id = null;
        public String reasonReturn = null;
        public Integer accountId = null;
        public Integer approverId = null;
        @StringLength(500)
        public String updatedBy = null;

        @StringLength(500)
        public String createdBy = null;

        public Boolean isParty = null;
        public Boolean isRevisionRequested = null;
        public Boolean isPrivate = null;
        public Integer departmentId = null;
        public Date publicationDate = null;
        public Integer processStatusId = null;
        public Integer documentTypeId = null;
        public Integer documentGroupId = null;
        public String accountName = null;
        public String acceptAccountName = null;
        public String documentGroupText = null;
        public String processStatusText = null;
        public String documentTypeText = null;
        public String departmentText = null;
        public String statusText = null;
        public String issuingAgencyText = null;
        public String subjectText = null;
        public String comment = null;
        public String submitComment = null;
        public String fullFile = null;
        public String parthFile = null;
        public Boolean isActive = null;
        public Integer stepOrder = null;
        public Integer stepCount = null;
        
        public String getTitle() { return title; }
        public DocumentSearchResultItem setTitle(String value) { this.title = value; return this; }
        public String getDescription() { return description; }
        public DocumentSearchResultItem setDescription(String value) { this.description = value; return this; }
        public String getOwner() { return owner; }
        public DocumentSearchResultItem setOwner(String value) { this.owner = value; return this; }
        public Integer getDocumentPolicyId() { return documentPolicyId; }
        public DocumentSearchResultItem setDocumentPolicyId(Integer value) { this.documentPolicyId = value; return this; }
        public Integer getUpdateDocumentId() { return updateDocumentId; }
        public DocumentSearchResultItem setUpdateDocumentId(Integer value) { this.updateDocumentId = value; return this; }
        public Date getEffectBeginDate() { return effectBeginDate; }
        public DocumentSearchResultItem setEffectBeginDate(Date value) { this.effectBeginDate = value; return this; }
        public Date getEffectEndDate() { return effectEndDate; }
        public DocumentSearchResultItem setEffectEndDate(Date value) { this.effectEndDate = value; return this; }
        public Integer getIssuingAgencyId() { return issuingAgencyId; }
        public DocumentSearchResultItem setIssuingAgencyId(Integer value) { this.issuingAgencyId = value; return this; }
        public Integer getSubjectId() { return subjectId; }
        public DocumentSearchResultItem setSubjectId(Integer value) { this.subjectId = value; return this; }
        public String getSignBy() { return signBy; }
        public DocumentSearchResultItem setSignBy(String value) { this.signBy = value; return this; }
        public Date getSignDate() { return signDate; }
        public DocumentSearchResultItem setSignDate(Date value) { this.signDate = value; return this; }
        public Date getUpdatedAt() { return updatedAt; }
        public DocumentSearchResultItem setUpdatedAt(Date value) { this.updatedAt = value; return this; }
        public Integer getStatusId() { return statusId; }
        public DocumentSearchResultItem setStatusId(Integer value) { this.statusId = value; return this; }
        public Boolean getIsInternal() { return isInternal; }
        public DocumentSearchResultItem setIsInternal(Boolean value) { this.isInternal = value; return this; }
        public String getDocumentNumber() { return documentNumber; }
        public DocumentSearchResultItem setDocumentNumber(String value) { this.documentNumber = value; return this; }
        public String getDocumentCode() { return documentCode; }
        public DocumentSearchResultItem setDocumentCode(String value) { this.documentCode = value; return this; }
        public Boolean getIsUrgent() { return isUrgent; }
        public DocumentSearchResultItem setIsUrgent(Boolean value) { this.isUrgent = value; return this; }
        public Integer getId() { return id; }
        public DocumentSearchResultItem setId(Integer value) { this.id = value; return this; }
        public String getReasonReturn() { return reasonReturn; }
        public DocumentSearchResultItem setReasonReturn(String value) { this.reasonReturn = value; return this; }
        public Integer getAccountId() { return accountId; }
        public DocumentSearchResultItem setAccountId(Integer value) { this.accountId = value; return this; }
        public Integer getApproverId() { return approverId; }
        public DocumentSearchResultItem setApproverId(Integer value) { this.approverId = value; return this; }
        public String getUpdatedBy() { return updatedBy; }
        public DocumentSearchResultItem setUpdatedBy(String value) { this.updatedBy = value; return this; }
        public String getCreatedBy() { return createdBy; }
        public DocumentSearchResultItem setCreatedBy(String value) { this.createdBy = value; return this; }
        public Boolean getIsParty() { return isParty; }
        public DocumentSearchResultItem setIsParty(Boolean value) { this.isParty = value; return this; }
        public Boolean getIsRevisionRequested() { return isRevisionRequested; }
        public DocumentSearchResultItem setIsRevisionRequested(Boolean value) { this.isRevisionRequested = value; return this; }
        public Boolean getIsPrivate() { return isPrivate; }
        public DocumentSearchResultItem setIsPrivate(Boolean value) { this.isPrivate = value; return this; }
        public Integer getDepartmentId() { return departmentId; }
        public DocumentSearchResultItem setDepartmentId(Integer value) { this.departmentId = value; return this; }
        public Date getPublicationDate() { return publicationDate; }
        public DocumentSearchResultItem setPublicationDate(Date value) { this.publicationDate = value; return this; }
        public Integer getProcessStatusId() { return processStatusId; }
        public DocumentSearchResultItem setProcessStatusId(Integer value) { this.processStatusId = value; return this; }
        public Integer getDocumentTypeId() { return documentTypeId; }
        public DocumentSearchResultItem setDocumentTypeId(Integer value) { this.documentTypeId = value; return this; }
        public Integer getDocumentGroupId() { return documentGroupId; }
        public DocumentSearchResultItem setDocumentGroupId(Integer value) { this.documentGroupId = value; return this; }
        public String getAccountName() { return accountName; }
        public DocumentSearchResultItem setAccountName(String value) { this.accountName = value; return this; }
        public String getAcceptAccountName() { return acceptAccountName; }
        public DocumentSearchResultItem setAcceptAccountName(String value) { this.acceptAccountName = value; return this; }
        public String getDocumentGroupText() { return documentGroupText; }
        public DocumentSearchResultItem setDocumentGroupText(String value) { this.documentGroupText = value; return this; }
        public String getProcessStatusText() { return processStatusText; }
        public DocumentSearchResultItem setProcessStatusText(String value) { this.processStatusText = value; return this; }
        public String getDocumentTypeText() { return documentTypeText; }
        public DocumentSearchResultItem setDocumentTypeText(String value) { this.documentTypeText = value; return this; }
        public String getDepartmentText() { return departmentText; }
        public DocumentSearchResultItem setDepartmentText(String value) { this.departmentText = value; return this; }
        public String getStatusText() { return statusText; }
        public DocumentSearchResultItem setStatusText(String value) { this.statusText = value; return this; }
        public String getIssuingAgencyText() { return issuingAgencyText; }
        public DocumentSearchResultItem setIssuingAgencyText(String value) { this.issuingAgencyText = value; return this; }
        public String getSubjectText() { return subjectText; }
        public DocumentSearchResultItem setSubjectText(String value) { this.subjectText = value; return this; }
        public String getComment() { return comment; }
        public DocumentSearchResultItem setComment(String value) { this.comment = value; return this; }
        public String getSubmitComment() { return submitComment; }
        public DocumentSearchResultItem setSubmitComment(String value) { this.submitComment = value; return this; }
        public String getFullFile() { return fullFile; }
        public DocumentSearchResultItem setFullFile(String value) { this.fullFile = value; return this; }
        public String getParthFile() { return parthFile; }
        public DocumentSearchResultItem setParthFile(String value) { this.parthFile = value; return this; }
        public Boolean getIsActive() { return isActive; }
        public DocumentSearchResultItem setIsActive(Boolean value) { this.isActive = value; return this; }
        public Integer getStepOrder() { return stepOrder; }
        public DocumentSearchResultItem setStepOrder(Integer value) { this.stepOrder = value; return this; }
        public Integer getStepCount() { return stepCount; }
        public DocumentSearchResultItem setStepCount(Integer value) { this.stepCount = value; return this; }
    }

}

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

{
	columns: 
	[
		String
	],
	title: String,
	typeId: 0,
	groupId: 0,
	subjectId: 0,
	isUrgent: False,
	documentSearchStage: All,
	isInternal: False,
	fromDate: "0001-01-01T00:00:00.0000000+07:06",
	toDate: "0001-01-01T00:00:00.0000000+07:06",
	statusId: 0,
	issuingAgencyId: 0,
	orderBy: UpdatedDateDesc,
	isParty: False,
	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
}