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 .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 /document-template HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateOrUpdateTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Description>String</Description>
  <DocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DocumentIds>
  <Elements>
    <DocumentElementDto>
      <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
      <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
      <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
      <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
      <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
      <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
      <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
      <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
      <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
      <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
      <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
      <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
      <Children>
        <DocumentElementDto>
          <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
          <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
          <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
          <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
          <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
          <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
          <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
          <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
          <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
          <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
          <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
          <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
          <Children>
            <DocumentElementDto>
              <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
              <DataType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</DataType>
              <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
              <ElementKey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ElementKey>
              <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
              <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
              <OrderIndex xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</OrderIndex>
              <ParentId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</ParentId>
              <Tag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Tag>
              <TemplateId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</TemplateId>
              <TemplateType xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</TemplateType>
              <Title xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Title>
              <Children i:nil="true" />
            </DocumentElementDto>
          </Children>
        </DocumentElementDto>
      </Children>
    </DocumentElementDto>
  </Elements>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <Title>String</Title>
</CreateOrUpdateTemplateRequest>

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

<CreateDocumentTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
</CreateDocumentTemplateResponse>