tvpl.api

<back to all web services

GetTemplateByDocumentIdRequest

Requires Authentication
The following routes are available for this service:
GET/document-template/bydocument
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 DocumentElementDto
        : DocumentElement
    {
        public DocumentElementDto()
        {
            Children = new List<DocumentElementDto>{};
        }

        public virtual List<DocumentElementDto> Children { get; set; }
    }

    public partial class DocumentTemplateDto
        : DocumentTemplate
    {
        public DocumentTemplateDto()
        {
            Elements = new List<DocumentElementDto>{};
        }

        public virtual List<DocumentElementDto> Elements { get; set; }
    }

    public partial class DocumentTemplateResponse
    {
        public virtual DocumentTemplateDto Template { get; set; }
        public virtual int InsertedId { get; set; }
        public virtual int Code { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class GetTemplateByDocumentIdRequest
    {
        public virtual int DocumentId { 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 DocumentElement
    {
        public virtual int Id { get; set; }
        public virtual int TemplateId { get; set; }
        [Required]
        public virtual string ElementKey { get; set; }

        [Required]
        public virtual string Tag { get; set; }

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

        public virtual string Description { get; set; }
        [Required]
        public virtual string DataType { get; set; }

        public virtual string TemplateType { get; set; }
        public virtual int OrderIndex { get; set; }
        public virtual bool? IsRequired { 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# GetTemplateByDocumentIdRequest 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-template/bydocument HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	template: 
	{
		elements: 
		[
			{
				children: 
				[
					{
						children: 
						[
							{
								id: 0,
								templateId: 0,
								elementKey: String,
								tag: String,
								parentId: 0,
								title: String,
								description: String,
								dataType: String,
								templateType: String,
								orderIndex: 0,
								isRequired: False
							}
						],
						id: 0,
						templateId: 0,
						elementKey: String,
						tag: String,
						parentId: 0,
						title: String,
						description: String,
						dataType: String,
						templateType: String,
						orderIndex: 0,
						isRequired: False
					}
				],
				id: 0,
				templateId: 0,
				elementKey: String,
				tag: String,
				parentId: 0,
				title: String,
				description: String,
				dataType: String,
				templateType: String,
				orderIndex: 0,
				isRequired: False
			}
		],
		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
			}
		]
	},
	insertedId: 0,
	code: 0,
	message: String
}