tvpl.api

GetTemplateByDocumentIdRequest

The following routes are available for this service:
GET	/document-template/bydocument

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceModel
Imports tvpl.data.Models

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class DocumentElementDto
            Inherits DocumentElement
            Public Sub New()
                Children = New List(Of DocumentElementDto)
            End Sub

            Public Overridable Property Children As List(Of DocumentElementDto)
        End Class

        Public Partial Class DocumentTemplateDto
            Inherits DocumentTemplate
            Public Sub New()
                Elements = New List(Of DocumentElementDto)
            End Sub

            Public Overridable Property Elements As List(Of DocumentElementDto)
        End Class

        Public Partial Class DocumentTemplateResponse
            Public Overridable Property Template As DocumentTemplateDto
            Public Overridable Property InsertedId As Integer
            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class GetTemplateByDocumentIdRequest
            Public Overridable Property DocumentId As Integer
        End Class
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class BasicDocument
            <Required>
            Public Overridable Property Title As String

            <StringLength(4000)>
            Public Overridable Property Description As String

            <StringLength(500)>
            Public Overridable Property Owner As String

            Public Overridable Property DocumentPolicyId As Nullable(Of Integer)
            Public Overridable Property UpdateDocumentId As Nullable(Of Integer)
            Public Overridable Property EffectBeginDate As Nullable(Of Date)
            Public Overridable Property EffectEndDate As Nullable(Of Date)
            Public Overridable Property IssuingAgencyId As Nullable(Of Integer)
            Public Overridable Property DocumentTypeId As Nullable(Of Integer)
            Public Overridable Property DocumentGroupId As Nullable(Of Integer)
            Public Overridable Property SubjectId As Nullable(Of Integer)
            <StringLength(500)>
            Public Overridable Property SignBy As String

            Public Overridable Property SignDate As Nullable(Of Date)
            Public Overridable Property StatusId As Nullable(Of Integer)
            Public Overridable Property IsInternal As Boolean
            Public Overridable Property DocumentNumber As String
            Public Overridable Property DocumentCode As String
            Public Overridable Property IsUrgent As Nullable(Of Boolean)
            Public Overridable Property ScopeType As Nullable(Of Integer)
            Public Overridable Property IsActive As Nullable(Of Boolean)
        End Class

        Public Partial Class Document
            Inherits BasicDocument
            Public Overridable Property Id As Integer
            <StringLength(500)>
            Public Overridable Property ReasonReturn As String

            Public Overridable Property AccountId As Nullable(Of Integer)
            Public Overridable Property DeletedAt As Nullable(Of Date)
            <StringLength(500)>
            Public Overridable Property DeletedBy As String

            <StringLength(500)>
            Public Overridable Property UpdatedBy As String

            Public Overridable Property CreatedAt As Nullable(Of Date)
            <StringLength(500)>
            Public Overridable Property CreatedBy As String

            Public Overridable Property IsParty As Nullable(Of Boolean)
            Public Overridable Property IsRevisionRequested As Boolean
            Public Overridable Property LastUpdatedAt As Nullable(Of Date)
            Public Overridable Property IsPrivate As Nullable(Of Boolean)
            Public Overridable Property DepartmentId As Nullable(Of Integer)
            Public Overridable Property PublicationDate As Nullable(Of Date)
            Public Overridable Property ProcessStatusId As Nullable(Of Integer)
            Public Overridable Property FullTextSearchContent As String
        End Class

        Public Partial Class DocumentElement
            Public Overridable Property Id As Integer
            Public Overridable Property TemplateId As Integer
            <Required>
            Public Overridable Property ElementKey As String

            <Required>
            Public Overridable Property Tag As String

            Public Overridable Property ParentId As Nullable(Of Integer)
            <Required>
            Public Overridable Property Title As String

            Public Overridable Property Description As String
            <Required>
            Public Overridable Property DataType As String

            Public Overridable Property TemplateType As String
            Public Overridable Property OrderIndex As Integer
            Public Overridable Property IsRequired As Nullable(Of Boolean)
        End Class

        Public Partial Class DocumentTemplate
            Public Sub New()
                DocumentIds = New List(Of Integer)
                Documents = New List(Of Document)
            End Sub

            Public Overridable Property Id As Integer
            <Required>
            Public Overridable Property Title As String

            Public Overridable Property Description As String
            Public Overridable Property IsActive As Boolean
            <Ignore>
            Public Overridable Property DocumentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property Documents As List(Of Document)
        End Class
    End Namespace
End Namespace

VB.NET GetTemplateByDocumentIdRequest 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/bydocument HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
  <Template>
    <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
    <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</CreatedBy>
    <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
    <DocumentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
      <d3p1:int>0</d3p1:int>
    </DocumentIds>
    <Documents xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
      <Document>
        <Description>String</Description>
        <DocumentCode>String</DocumentCode>
        <DocumentGroupId>0</DocumentGroupId>
        <DocumentNumber>String</DocumentNumber>
        <DocumentPolicyId>0</DocumentPolicyId>
        <DocumentTypeId>0</DocumentTypeId>
        <EffectBeginDate>0001-01-01T00:00:00</EffectBeginDate>
        <EffectEndDate>0001-01-01T00:00:00</EffectEndDate>
        <IsActive>false</IsActive>
        <IsInternal>false</IsInternal>
        <IsUrgent>false</IsUrgent>
        <IssuingAgencyId>0</IssuingAgencyId>
        <Owner>String</Owner>
        <ScopeType>0</ScopeType>
        <SignBy>String</SignBy>
        <SignDate>0001-01-01T00:00:00</SignDate>
        <StatusId>0</StatusId>
        <SubjectId>0</SubjectId>
        <Title>String</Title>
        <UpdateDocumentId>0</UpdateDocumentId>
        <AccountId>0</AccountId>
        <CreatedAt>0001-01-01T00:00:00</CreatedAt>
        <CreatedBy>String</CreatedBy>
        <DeletedAt>0001-01-01T00:00:00</DeletedAt>
        <DeletedBy>String</DeletedBy>
        <DepartmentId>0</DepartmentId>
        <FullTextSearchContent>String</FullTextSearchContent>
        <Id>0</Id>
        <IsParty>false</IsParty>
        <IsPrivate>false</IsPrivate>
        <IsRevisionRequested>false</IsRevisionRequested>
        <LastUpdatedAt>0001-01-01T00:00:00</LastUpdatedAt>
        <ProcessStatusId>0</ProcessStatusId>
        <PublicationDate>0001-01-01T00:00:00</PublicationDate>
        <ReasonReturn>String</ReasonReturn>
        <UpdatedBy>String</UpdatedBy>
      </Document>
    </Documents>
    <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsActive>
    <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
    <Elements>
      <DocumentElementDto>
        <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
        <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
        <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
        <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
        <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
        <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
        <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
        <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
        <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
        <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
        <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
        <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
        <Children>
          <DocumentElementDto>
            <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
            <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
            <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
            <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
            <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
            <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
            <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
            <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
            <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
            <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
            <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
            <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
            <Children>
              <DocumentElementDto>
                <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
                <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
                <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
                <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
                <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
                <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
                <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
                <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
                <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
                <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
                <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
                <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
                <Children i:nil="true" />
              </DocumentElementDto>
            </Children>
          </DocumentElementDto>
        </Children>
      </DocumentElementDto>
    </Elements>
  </Template>
</DocumentTemplateResponse>