tvpl.api

<back to all web services

ReadAndImportDataApi

Requires Authentication
Required role:super-admin
The following routes are available for this service:
POST/import-from-excel
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 ReadExcelResponse:
    rows: Optional[List[List[str]]] = None
    max_column_r: Decimal = decimal.Decimal(0)


class IHttpFile:
    name: Optional[str] = None
    file_name: Optional[str] = None
    content_length: int = 0
    content_type: Optional[str] = None
    input_stream: Optional[bytes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReadAndImportDataApi:
    data_file: Optional[IHttpFile] = None
    is_internal: bool = False

Python ReadAndImportDataApi 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 /import-from-excel HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReadAndImportDataApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <DataFile i:nil="true" />
  <IsInternal>false</IsInternal>
</ReadAndImportDataApi>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReadExcelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <MaxColumnR>0</MaxColumnR>
  <Rows xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>String</d2p1:string>
    </d2p1:ArrayOfstring>
  </Rows>
</ReadExcelResponse>