tvpl.api

CreateOrUpdateTemplateRequest

**Requires Authentication**
Required role:	super-admin

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

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 CreateDocumentTemplateResponse(IResponseRequest):
    inserted_id: int = 0
    code: int = 0
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentElement:
    id: int = 0
    template_id: int = 0
    # @Required()
    element_key: Optional[str] = None

    # @Required()
    tag: Optional[str] = None

    parent_id: Optional[int] = None
    # @Required()
    title: Optional[str] = None

    description: Optional[str] = None
    # @Required()
    data_type: Optional[str] = None

    template_type: Optional[str] = None
    order_index: int = 0
    is_required: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentElementDto(DocumentElement):
    children: Optional[List[DocumentElementDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateOrUpdateTemplateRequest:
    id: Optional[int] = None
    document_ids: Optional[List[int]] = None
    title: Optional[str] = None
    description: Optional[str] = None
    is_active: bool = False
    elements: Optional[List[DocumentElementDto]] = None

Python CreateOrUpdateTemplateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /document-template HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":0,"documentIds":[0],"title":"String","description":"String","isActive":false,"elements":[{"children":[{"children":[{"children":null,"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}],"id":0,"templateId":0,"elementKey":"String","tag":"String","parentId":0,"title":"String","description":"String","dataType":"String","templateType":"String","orderIndex":0,"isRequired":false}]}

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

{"insertedId":0,"code":0,"message":"String"}