FIBUdataServiceStack

<back to all web services

DokumentUploadRequest

The following routes are available for this service:
GET, POST/fibuscan/DokumentUpload
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 dokumente(IPrimaryKey, IMandnr, IDel, ITableBaseErstelltAenderung):
    id: Optional[int] = None
    _erstellt: Optional[datetime.datetime] = None
    _aenderung: Optional[datetime.datetime] = None
    mandant: Optional[int] = None
    datenindex: Optional[int] = None
    dateiname: Optional[str] = None
    zip_dateiname: Optional[str] = None
    sub_pfad: Optional[str] = None
    upload: Optional[int] = None
    download_ext: Optional[int] = None
    datum: Optional[datetime.datetime] = None
    link: Optional[str] = None
    anlagen: Optional[str] = None
    metadaten: Optional[str] = None
    dateityp: Optional[int] = None
    del_: Optional[int] = field(metadata=config(field_name='del'), default=None)
    hash: Optional[str] = None
    guid: Optional[str] = None
    # @Ignore()
    server_hash: Optional[str] = None

    # @Ignore()
    primary_key: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DokumentUploadResponse:
    dokument: Optional[dokumente] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DokumentUploadRequest:
    dokumente_id: int = 0
    hash: Optional[str] = None
    response_status: Optional[ResponseStatus] = None

Python DokumentUploadRequest 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 /fibuscan/DokumentUpload HTTP/1.1 
Host: ws4.fibudata.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DokumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Messages">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <dokumente_id>0</dokumente_id>
  <hash>String</hash>
</DokumentUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DokumentUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Messages">
  <dokument xmlns:d2p1="http://schemas.datacontract.org/2004/07/FIBUdataServiceStack.ServiceModel.Models">
    <d2p1:Dateiname>String</d2p1:Dateiname>
    <d2p1:Datenindex>0</d2p1:Datenindex>
    <d2p1:Datum>0001-01-01T00:00:00</d2p1:Datum>
    <d2p1:DownloadExt>0</d2p1:DownloadExt>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:Link>String</d2p1:Link>
    <d2p1:PrimaryKey>0</d2p1:PrimaryKey>
    <d2p1:SubPfad>String</d2p1:SubPfad>
    <d2p1:Upload>0</d2p1:Upload>
    <d2p1:_aenderung>0001-01-01T00:00:00</d2p1:_aenderung>
    <d2p1:_erstellt>0001-01-01T00:00:00</d2p1:_erstellt>
    <d2p1:anlagen>String</d2p1:anlagen>
    <d2p1:dateityp>0</d2p1:dateityp>
    <d2p1:del>0</d2p1:del>
    <d2p1:guid>String</d2p1:guid>
    <d2p1:hash>String</d2p1:hash>
    <d2p1:mandant>0</d2p1:mandant>
    <d2p1:metadaten>String</d2p1:metadaten>
    <d2p1:server_hash>String</d2p1:server_hash>
    <d2p1:zip_dateiname>String</d2p1:zip_dateiname>
  </dokument>
</DokumentUploadResponse>