tvpl.api

<back to all web services

SearchTemplateRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/search
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using tvpl.api.ServiceModel;
using tvpl.data.Models;

namespace tvpl.api.ServiceModel
{
    public partial class PagingRequest
    {
        public virtual int Page { get; set; }
        public virtual int Limit { get; set; }
    }

    public partial class SearchDocumentTemplateResponse
        : IResponseRequest
    {
        public SearchDocumentTemplateResponse()
        {
            Data = new List<DocumentTemplate>{};
        }

        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
        public virtual List<DocumentTemplate> Data { get; set; }
        public virtual long TotalCount { get; set; }
    }

    public partial class SearchTemplateRequest
        : PagingRequest
    {
        public virtual string Title { get; set; }
    }

}

namespace tvpl.data.Models
{
    public partial class BasicDocument
    {
        [Required]
        public virtual string Title { get; set; }

        [StringLength(4000)]
        public virtual string Description { get; set; }

        [StringLength(500)]
        public virtual string Owner { get; set; }

        public virtual int? DocumentPolicyId { get; set; }
        public virtual int? UpdateDocumentId { get; set; }
        public virtual DateTime? EffectBeginDate { get; set; }
        public virtual DateTime? EffectEndDate { get; set; }
        public virtual int? IssuingAgencyId { get; set; }
        public virtual int? DocumentTypeId { get; set; }
        public virtual int? DocumentGroupId { get; set; }
        public virtual int? SubjectId { get; set; }
        [StringLength(500)]
        public virtual string SignBy { get; set; }

        public virtual DateTime? SignDate { get; set; }
        public virtual int? StatusId { get; set; }
        public virtual bool IsInternal { get; set; }
        public virtual string DocumentNumber { get; set; }
        public virtual string DocumentCode { get; set; }
        public virtual bool? IsUrgent { get; set; }
        public virtual int? ScopeType { get; set; }
        public virtual bool? IsActive { get; set; }
    }

    public partial class Document
        : BasicDocument
    {
        public virtual int Id { get; set; }
        [StringLength(500)]
        public virtual string ReasonReturn { get; set; }

        public virtual int? AccountId { get; set; }
        public virtual DateTime? DeletedAt { get; set; }
        [StringLength(500)]
        public virtual string DeletedBy { get; set; }

        [StringLength(500)]
        public virtual string UpdatedBy { get; set; }

        public virtual DateTime? CreatedAt { get; set; }
        [StringLength(500)]
        public virtual string CreatedBy { get; set; }

        public virtual bool? IsParty { get; set; }
        public virtual bool IsRevisionRequested { get; set; }
        public virtual DateTime? LastUpdatedAt { get; set; }
        public virtual bool? IsPrivate { get; set; }
        public virtual int? DepartmentId { get; set; }
        public virtual DateTime? PublicationDate { get; set; }
        public virtual int? ProcessStatusId { get; set; }
        public virtual string FullTextSearchContent { get; set; }
    }

    public partial class DocumentTemplate
    {
        public DocumentTemplate()
        {
            DocumentIds = new List<int>{};
            Documents = new List<Document>{};
        }

        public virtual int Id { get; set; }
        [Required]
        public virtual string Title { get; set; }

        public virtual string Description { get; set; }
        public virtual bool IsActive { get; set; }
        [Ignore]
        public virtual List<int> DocumentIds { get; set; }

        [Ignore]
        public virtual List<Document> Documents { get; set; }
    }

}

C# SearchTemplateRequest 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.

GET /document-template/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchDocumentTemplateResponse 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:DocumentTemplate>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:DocumentIds>
      <d2p1:Documents>
        <d2p1:Document>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:DocumentGroupId>0</d2p1:DocumentGroupId>
          <d2p1:DocumentNumber>String</d2p1:DocumentNumber>
          <d2p1:DocumentPolicyId>0</d2p1:DocumentPolicyId>
          <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
          <d2p1:EffectBeginDate>0001-01-01T00:00:00</d2p1:EffectBeginDate>
          <d2p1:EffectEndDate>0001-01-01T00:00:00</d2p1:EffectEndDate>
          <d2p1:IsActive>false</d2p1:IsActive>
          <d2p1:IsInternal>false</d2p1:IsInternal>
          <d2p1:IsUrgent>false</d2p1:IsUrgent>
          <d2p1:IssuingAgencyId>0</d2p1:IssuingAgencyId>
          <d2p1:Owner>String</d2p1:Owner>
          <d2p1:ScopeType>0</d2p1:ScopeType>
          <d2p1:SignBy>String</d2p1:SignBy>
          <d2p1:SignDate>0001-01-01T00:00:00</d2p1:SignDate>
          <d2p1:StatusId>0</d2p1:StatusId>
          <d2p1:SubjectId>0</d2p1:SubjectId>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:UpdateDocumentId>0</d2p1:UpdateDocumentId>
          <d2p1:AccountId>0</d2p1:AccountId>
          <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
          <d2p1:CreatedBy>String</d2p1:CreatedBy>
          <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
          <d2p1:DeletedBy>String</d2p1:DeletedBy>
          <d2p1:DepartmentId>0</d2p1:DepartmentId>
          <d2p1:FullTextSearchContent>String</d2p1:FullTextSearchContent>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsParty>false</d2p1:IsParty>
          <d2p1:IsPrivate>false</d2p1:IsPrivate>
          <d2p1:IsRevisionRequested>false</d2p1:IsRevisionRequested>
          <d2p1:LastUpdatedAt>0001-01-01T00:00:00</d2p1:LastUpdatedAt>
          <d2p1:ProcessStatusId>0</d2p1:ProcessStatusId>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:ReasonReturn>String</d2p1:ReasonReturn>
          <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
        </d2p1:Document>
      </d2p1:Documents>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:DocumentTemplate>
  </Data>
  <Message>String</Message>
  <TotalCount>0</TotalCount>
</SearchDocumentTemplateResponse>