tvpl.api

MergeFileRequest

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 ElementInputDto:
    value: Optional[Object] = None
    data_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MergeFileRequest:
    workflow_id: int = 0
    template: Optional[TemplateDefinitionDto] = None
    elements: Optional[Dict[str, ElementInputDto]] = 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 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringElementInputDtoW9RP9JSa>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <DataType>String</DataType>
        <Value />
      </d2p1:Value>
    </d2p1:KeyValueOfstringElementInputDtoW9RP9JSa>
  </Elements>
  <Template>
    <Description>String</Description>
    <DocumentId>0</DocumentId>
    <Id>0</Id>
    <IsActive>false</IsActive>
    <Title>String</Title>
  </Template>
  <WorkflowId>0</WorkflowId>
</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/" />