Server

<back to all web services

GetEras2FileList

Eras2Files
Requires Authentication
The following routes are available for this service:
GET/api/v1/eras2files
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 Eras2FileType(str, Enum):
    D_SATZ = 'DSatz'
    HKA = 'Hka'
    E835_SATZ = 'E835Satz'
    E898_SATZ = 'E898Satz'
    ABRECHNUNG = 'Abrechnung'
    ARGE_SATZ = 'ArgeSatz'
    NUTZER_FILE = 'NutzerFile'
    DEVICE_PDF = 'DevicePdf'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Eras2File:
    guid: Optional[str] = None
    name: Optional[str] = None
    file_type: Optional[Eras2FileType] = None
    objekt_guid: Optional[str] = None
    nutzer_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEras2FileListResponse:
    eras2_file_list: Optional[List[Eras2File]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEras2FileList(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="query")
    bearer_token: Optional[str] = None

    # @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*", ParameterType="query")
    filter_by_file_type: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*
    """


    # @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[Name]=*", ParameterType="query")
    filter_by_name: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/eras2files?filter[Name]=*
    """

Python GetEras2FileList 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.

GET /api/v1/eras2files HTTP/1.1 
Host: kromer-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEras2FileListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Eras2FileList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <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>
</GetEras2FileListResponse>