Server

GetEras2File

Eras2Files

The following routes are available for this service:
GET	/api/v1/eras2files/{Guid}

<?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 GetEras2FileResponse implements JsonSerializable
{
    public function __construct(
        /** @var Eras2File|null */
        public ?Eras2File $eras2File=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

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

        // @ApiMember(IsRequired=true, ParameterType="path")
        /** @var string */
        public string $guid=''
    ) {
    }

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

PHP GetEras2File DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/eras2files/{Guid} HTTP/1.1 
Host: immo-account-servdesk.eras-online.de 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"eras2File":{"Guid":"00000000000000000000000000000000","Name":"String","FileType":"DSatz","ObjektGuid":"00000000000000000000000000000000","NutzerGuid":"00000000000000000000000000000000"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}