tvpl.api

<back to all web services

MergeFileRequest

Requires Authentication
The following routes are available for this service:
POST/merge-file
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceModel

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class ElementDefinitionDto
            Public Sub New()
                Children = New List(Of ElementDefinitionDto)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property TemplateId As Integer
            Public Overridable Property ElementKey As String
            Public Overridable Property Tag As String
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property DataType As String
            Public Overridable Property TemplateType As String
            Public Overridable Property OrderIndex As Integer
            Public Overridable Property ParentId As Nullable(Of Integer)
            Public Overridable Property Value As Object
            Public Overridable Property Children As List(Of ElementDefinitionDto)
        End Class

        Public Partial Class MergeFileRequest
            Public Sub New()
                Elements = New List(Of ElementDefinitionDto)
            End Sub

            Public Overridable Property Template As TemplateDefinitionDto
            Public Overridable Property Elements As List(Of ElementDefinitionDto)
        End Class

        Public Partial Class TemplateDefinitionDto
            Public Overridable Property Id As Integer
            Public Overridable Property DocumentId As Integer
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property IsActive As Boolean
        End Class
    End Namespace
End Namespace

VB.NET MergeFileRequest 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.

POST /merge-file HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MergeFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Elements>
    <ElementDefinitionDto>
      <Children>
        <ElementDefinitionDto>
          <Children>
            <ElementDefinitionDto>
              <Children i:nil="true" />
              <DataType>String</DataType>
              <Description>String</Description>
              <ElementKey>String</ElementKey>
              <Id>0</Id>
              <OrderIndex>0</OrderIndex>
              <ParentId>0</ParentId>
              <Tag>String</Tag>
              <TemplateId>0</TemplateId>
              <TemplateType>String</TemplateType>
              <Title>String</Title>
              <Value />
            </ElementDefinitionDto>
          </Children>
          <DataType>String</DataType>
          <Description>String</Description>
          <ElementKey>String</ElementKey>
          <Id>0</Id>
          <OrderIndex>0</OrderIndex>
          <ParentId>0</ParentId>
          <Tag>String</Tag>
          <TemplateId>0</TemplateId>
          <TemplateType>String</TemplateType>
          <Title>String</Title>
          <Value />
        </ElementDefinitionDto>
      </Children>
      <DataType>String</DataType>
      <Description>String</Description>
      <ElementKey>String</ElementKey>
      <Id>0</Id>
      <OrderIndex>0</OrderIndex>
      <ParentId>0</ParentId>
      <Tag>String</Tag>
      <TemplateId>0</TemplateId>
      <TemplateType>String</TemplateType>
      <Title>String</Title>
      <Value />
    </ElementDefinitionDto>
  </Elements>
  <Template>
    <Description>String</Description>
    <DocumentId>0</DocumentId>
    <Id>0</Id>
    <IsActive>false</IsActive>
    <Title>String</Title>
  </Template>
</MergeFileRequest>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />