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 .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.

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

{
	template: 
	{
		id: 0,
		documentId: 0,
		title: String,
		description: String,
		isActive: False
	},
	elements: 
	[
		{
			id: 0,
			templateId: 0,
			elementKey: String,
			tag: String,
			title: String,
			description: String,
			dataType: String,
			templateType: String,
			orderIndex: 0,
			parentId: 0,
			value: {},
			children: 
			[
				{
					id: 0,
					templateId: 0,
					elementKey: String,
					tag: String,
					title: String,
					description: String,
					dataType: String,
					templateType: String,
					orderIndex: 0,
					parentId: 0,
					value: {},
					children: 
					[
						{
							id: 0,
							templateId: 0,
							elementKey: String,
							tag: String,
							title: String,
							description: String,
							dataType: String,
							templateType: String,
							orderIndex: 0,
							parentId: 0,
							value: {}
						}
					]
				}
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}