tvpl.api

<back to all web services

SearchDocumentReferenceRequest

Requires Authentication
Required role:super-admin
The following routes are available for this service:
GET/document-reference/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 PageResponse<AuditLog>
        : IResponseRequest
    {
        public PageResponse()
        {
            Data = new List<AuditLog>{};
        }

        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
        public virtual List<AuditLog> Data { get; set; }
        public virtual Pagination Pagination { get; set; }
    }

    public partial class Pagination
    {
        public virtual long Total { get; set; }
        public virtual int Pages { get; set; }
        public virtual long Offset { get; set; }
        public virtual int Limit { get; set; }
        public virtual int CurrentPage { get; set; }
    }

    public partial class PagingRequest
    {
        public virtual int Page { get; set; }
        public virtual int Limit { get; set; }
    }

    public partial class SearchDocumentReferenceRequest
        : PagingRequest
    {
        public virtual string DocumentCode { get; set; }
        public virtual int? ParentDocumentId { get; set; }
        public virtual string Title { get; set; }
    }

}

namespace tvpl.data.Models
{
    public partial class AuditLog
        : MongoObject, IEntityId, ICreated, IUpdate
    {
        public virtual string UserName { get; set; }
        public virtual int? UserId { get; set; }
        public virtual int DocumentId { get; set; }
        public virtual string Action { get; set; }
        public virtual string Description { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime UpdatedDate { get; set; }
        public virtual string IpAddress { get; set; }
        public virtual string UserAgent { get; set; }
    }

    public partial class MongoObject
        : IMongoModel
    {
        public virtual string Id { get; set; }
    }

}

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

GET /document-reference/search HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			id: 0,
			parentDocumentId: 0,
			title: String,
			documentCode: String,
			referenceUrl: String,
			description: String
		}
	]
}