tvpl.api

<back to all web services

UpdateAppConfigsBySection

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/app-configs/{Section}
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


class AppConfigSection(str, Enum):
    APP_INFO = 'AppInfo'
    SMTP = 'Smtp'
    KEYCLOAK = 'Keycloak'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppConfigItem:
    key: Optional[str] = None
    value: Optional[str] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateAppConfigsBySection:
    section: Optional[AppConfigSection] = None
    items: Optional[List[AppConfigItem]] = None

Python UpdateAppConfigsBySection 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 /app-configs/{Section} HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAppConfigsBySection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:AppConfigItem>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:AppConfigItem>
  </Items>
  <Section>AppInfo</Section>
</UpdateAppConfigsBySection>
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/" />