Server

<back to all web services

GetEras2FileList

Eras2Files
Requires Authentication
The following routes are available for this service:
GET/api/v1/eras2files
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum Eras2FileType : string
{
    case DSatz = 'DSatz';
    case Hka = 'Hka';
    case E835Satz = 'E835Satz';
    case E898Satz = 'E898Satz';
    case Abrechnung = 'Abrechnung';
    case ArgeSatz = 'ArgeSatz';
    case NutzerFile = 'NutzerFile';
    case DevicePdf = 'DevicePdf';
}

// @DataContract
class Eras2File implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="Guid")
        /** @var string */
        public string $Guid='',

        // @DataMember(Name="Name")
        /** @var string|null */
        public ?string $Name=null,

        // @DataMember(Name="FileType")
        /** @var Eras2FileType|null */
        public ?Eras2FileType $FileType=null,

        // @DataMember(Name="ObjektGuid")
        /** @var string|null */
        public ?string $ObjektGuid=null,

        // @DataMember(Name="NutzerGuid")
        /** @var string|null */
        public ?string $NutzerGuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Guid'])) $this->Guid = $o['Guid'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['FileType'])) $this->FileType = JsonConverters::from('Eras2FileType', $o['FileType']);
        if (isset($o['ObjektGuid'])) $this->ObjektGuid = $o['ObjektGuid'];
        if (isset($o['NutzerGuid'])) $this->NutzerGuid = $o['NutzerGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Guid)) $o['Guid'] = $this->Guid;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->FileType)) $o['FileType'] = JsonConverters::to('Eras2FileType', $this->FileType);
        if (isset($this->ObjektGuid)) $o['ObjektGuid'] = $this->ObjektGuid;
        if (isset($this->NutzerGuid)) $o['NutzerGuid'] = $this->NutzerGuid;
        return empty($o) ? new class(){} : $o;
    }
}

class GetEras2FileListResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<Eras2File>|null */
        public ?array $eras2FileList=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['eras2FileList'])) $this->eras2FileList = JsonConverters::fromArray('Eras2File', $o['eras2FileList']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->eras2FileList)) $o['eras2FileList'] = JsonConverters::toArray('Eras2File', $this->eras2FileList);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class GetEras2FileList implements IHasBearerToken, JsonSerializable
{
    public function __construct(
        // @ApiMember(IsRequired=true, ParameterType="query")
        /** @var string */
        public string $bearerToken='',

        /** @description Optional! Follow the format : /api/v1/eras2files?filter[FileType]=* */
        // @DataMember(Name="filter[FileType]")
        // @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*", ParameterType="query")
        /** @var string|null */
        public ?string $filter_FileType_=null,

        /** @description Optional! Follow the format : /api/v1/eras2files?filter[Name]=* */
        // @DataMember(Name="filter[Name]")
        // @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[Name]=*", ParameterType="query")
        /** @var string|null */
        public ?string $filter_Name_=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['bearerToken'])) $this->bearerToken = $o['bearerToken'];
        if (isset($o['filter_FileType_'])) $this->filter_FileType_ = $o['filter_FileType_'];
        if (isset($o['filter_Name_'])) $this->filter_Name_ = $o['filter_Name_'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->bearerToken)) $o['bearerToken'] = $this->bearerToken;
        if (isset($this->filter_FileType_)) $o['filter_FileType_'] = $this->filter_FileType_;
        if (isset($this->filter_Name_)) $o['filter_Name_'] = $this->filter_Name_;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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: fairtherm-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>