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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"code":0,"message":"String","data":[{"id":0,"title":"String","description":"String","isActive":false,"documentIds":[0],"documents":[{"id":0,"reasonReturn":"String","accountId":0,"deletedAt":"0001-01-01T00:00:00.0000000+07:06","deletedBy":"String","updatedBy":"String","createdAt":"0001-01-01T00:00:00.0000000+07:06","createdBy":"String","isParty":false,"isRevisionRequested":false,"lastUpdatedAt":"0001-01-01T00:00:00.0000000+07:06","isPrivate":false,"departmentId":0,"publicationDate":"0001-01-01T00:00:00.0000000+07:06","processStatusId":0,"fullTextSearchContent":"String","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,"documentTypeId":0,"documentGroupId":0,"subjectId":0,"signBy":"String","signDate":"0001-01-01T00:00:00.0000000+07:06","statusId":0,"isInternal":false,"documentNumber":"String","documentCode":"String","isUrgent":false,"scopeType":0,"isActive":false}]}],"totalCount":0}