tvpl.api

<back to all web services

ImportEquipmentRequest

Requires Authentication
Required permission:manage_equipment
The following routes are available for this service:
POST/equipment/import
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 ImportEquipmentRowError:
    row: int = 0
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImportEquipmentResponse:
    code: int = 0
    message: Optional[str] = None
    inserted: int = 0
    updated: int = 0
    skipped: int = 0
    errors: Optional[List[ImportEquipmentRowError]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImportEquipmentRequest:
    mode: Optional[str] = None

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

<ImportEquipmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Mode>String</Mode>
</ImportEquipmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ImportEquipmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Errors>
    <ImportEquipmentRowError>
      <Message>String</Message>
      <Row>0</Row>
    </ImportEquipmentRowError>
  </Errors>
  <Inserted>0</Inserted>
  <Message>String</Message>
  <Skipped>0</Skipped>
  <Updated>0</Updated>
</ImportEquipmentResponse>