tvpl.api

<back to all web services

MergeFileRequest

Requires Authentication
The following routes are available for this service:
POST/merge-file
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TemplateDefinitionDto:
    id: int = 0
    document_id: int = 0
    title: Optional[str] = None
    description: Optional[str] = None
    is_active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ElementDefinitionDto:
    id: int = 0
    template_id: int = 0
    element_key: Optional[str] = None
    tag: Optional[str] = None
    title: Optional[str] = None
    description: Optional[str] = None
    data_type: Optional[str] = None
    template_type: Optional[str] = None
    order_index: int = 0
    parent_id: Optional[int] = None
    value: Optional[Object] = None
    children: Optional[List[ElementDefinitionDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MergeFileRequest:
    template: Optional[TemplateDefinitionDto] = None
    elements: Optional[List[ElementDefinitionDto]] = None

Python 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/" />