| GET | /api/v1/objekte/{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};
// @DataContract
class Address implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string */
public string $guid='',
// @DataMember
/** @var string|null */
public ?string $street=null,
// @DataMember
/** @var string|null */
public ?string $street2=null,
// @DataMember
/** @var string|null */
public ?string $streetNumber=null,
// @DataMember
/** @var string|null */
public ?string $zipcode=null,
// @DataMember
/** @var string|null */
public ?string $city=null,
// @DataMember
/** @var string|null */
public ?string $mailbox=null,
// @DataMember
/** @var string|null */
public ?string $additional=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['guid'])) $this->guid = $o['guid'];
if (isset($o['street'])) $this->street = $o['street'];
if (isset($o['street2'])) $this->street2 = $o['street2'];
if (isset($o['streetNumber'])) $this->streetNumber = $o['streetNumber'];
if (isset($o['zipcode'])) $this->zipcode = $o['zipcode'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['mailbox'])) $this->mailbox = $o['mailbox'];
if (isset($o['additional'])) $this->additional = $o['additional'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->guid)) $o['guid'] = $this->guid;
if (isset($this->street)) $o['street'] = $this->street;
if (isset($this->street2)) $o['street2'] = $this->street2;
if (isset($this->streetNumber)) $o['streetNumber'] = $this->streetNumber;
if (isset($this->zipcode)) $o['zipcode'] = $this->zipcode;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->mailbox)) $o['mailbox'] = $this->mailbox;
if (isset($this->additional)) $o['additional'] = $this->additional;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class Nutzeinheit implements JsonSerializable
{
public function __construct(
// @DataMember(Name="Guid")
/** @var string|null */
public ?string $Guid=null,
// @DataMember(Name="Nummer")
/** @var string|null */
public ?string $Nummer=null,
// @DataMember(Name="Lage")
/** @var string|null */
public ?string $Lage=null,
// @DataMember(Name="ObjektGuid")
/** @var string|null */
public ?string $ObjektGuid=null,
// @DataMember(Name="AdressGuid")
/** @var string|null */
public ?string $AdressGuid=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Guid'])) $this->Guid = $o['Guid'];
if (isset($o['Nummer'])) $this->Nummer = $o['Nummer'];
if (isset($o['Lage'])) $this->Lage = $o['Lage'];
if (isset($o['ObjektGuid'])) $this->ObjektGuid = $o['ObjektGuid'];
if (isset($o['AdressGuid'])) $this->AdressGuid = $o['AdressGuid'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Guid)) $o['Guid'] = $this->Guid;
if (isset($this->Nummer)) $o['Nummer'] = $this->Nummer;
if (isset($this->Lage)) $o['Lage'] = $this->Lage;
if (isset($this->ObjektGuid)) $o['ObjektGuid'] = $this->ObjektGuid;
if (isset($this->AdressGuid)) $o['AdressGuid'] = $this->AdressGuid;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BillingInformation implements JsonSerializable
{
public function __construct(
// @DataMember(Name="Guid")
/** @var string|null */
public ?string $Guid=null,
// @DataMember(Name="Von")
/** @var DateTime */
public DateTime $Von=new DateTime(),
// @DataMember(Name="Bis")
/** @var DateTime */
public DateTime $Bis=new DateTime(),
// @DataMember(Name="IstAbgeschlossen")
/** @var bool|null */
public ?bool $IstAbgeschlossen=null,
// @DataMember(Name="HatNebenkosten")
/** @var bool|null */
public ?bool $HatNebenkosten=null,
// @DataMember(Name="ObjektGuid")
/** @var string|null */
public ?string $ObjektGuid=null,
// @DataMember(Name="AnmerkungKundenportal")
/** @var string|null */
public ?string $AnmerkungKundenportal=null,
// @DataMember(Name="KundenportalMarkedDone")
/** @var bool|null */
public ?bool $KundenportalMarkedDone=null,
// @DataMember(Name="MarkedDoneAt")
/** @var DateTime|null */
public ?DateTime $MarkedDoneAt=null,
// @DataMember(Name="KundenportalMarkedClosed")
/** @var bool|null */
public ?bool $KundenportalMarkedClosed=null,
// @DataMember(Name="MarkedClosedAt")
/** @var DateTime|null */
public ?DateTime $MarkedClosedAt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Guid'])) $this->Guid = $o['Guid'];
if (isset($o['Von'])) $this->Von = JsonConverters::from('DateTime', $o['Von']);
if (isset($o['Bis'])) $this->Bis = JsonConverters::from('DateTime', $o['Bis']);
if (isset($o['IstAbgeschlossen'])) $this->IstAbgeschlossen = $o['IstAbgeschlossen'];
if (isset($o['HatNebenkosten'])) $this->HatNebenkosten = $o['HatNebenkosten'];
if (isset($o['ObjektGuid'])) $this->ObjektGuid = $o['ObjektGuid'];
if (isset($o['AnmerkungKundenportal'])) $this->AnmerkungKundenportal = $o['AnmerkungKundenportal'];
if (isset($o['KundenportalMarkedDone'])) $this->KundenportalMarkedDone = $o['KundenportalMarkedDone'];
if (isset($o['MarkedDoneAt'])) $this->MarkedDoneAt = JsonConverters::from('DateTime', $o['MarkedDoneAt']);
if (isset($o['KundenportalMarkedClosed'])) $this->KundenportalMarkedClosed = $o['KundenportalMarkedClosed'];
if (isset($o['MarkedClosedAt'])) $this->MarkedClosedAt = JsonConverters::from('DateTime', $o['MarkedClosedAt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Guid)) $o['Guid'] = $this->Guid;
if (isset($this->Von)) $o['Von'] = JsonConverters::to('DateTime', $this->Von);
if (isset($this->Bis)) $o['Bis'] = JsonConverters::to('DateTime', $this->Bis);
if (isset($this->IstAbgeschlossen)) $o['IstAbgeschlossen'] = $this->IstAbgeschlossen;
if (isset($this->HatNebenkosten)) $o['HatNebenkosten'] = $this->HatNebenkosten;
if (isset($this->ObjektGuid)) $o['ObjektGuid'] = $this->ObjektGuid;
if (isset($this->AnmerkungKundenportal)) $o['AnmerkungKundenportal'] = $this->AnmerkungKundenportal;
if (isset($this->KundenportalMarkedDone)) $o['KundenportalMarkedDone'] = $this->KundenportalMarkedDone;
if (isset($this->MarkedDoneAt)) $o['MarkedDoneAt'] = JsonConverters::to('DateTime', $this->MarkedDoneAt);
if (isset($this->KundenportalMarkedClosed)) $o['KundenportalMarkedClosed'] = $this->KundenportalMarkedClosed;
if (isset($this->MarkedClosedAt)) $o['MarkedClosedAt'] = JsonConverters::to('DateTime', $this->MarkedClosedAt);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class Objekt implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string */
public string $guid='',
// @DataMember
/** @var string|null */
public ?string $number=null,
// @DataMember
/** @var string|null */
public ?string $isCompleted=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $completedDate=null,
// @DataMember
/** @var Address|null */
public ?Address $address=null,
// @DataMember
/** @var array<Nutzeinheit>|null */
public ?array $nutzeinheiten=null,
// @DataMember
/** @var array<BillingInformation>|null */
public ?array $billingInformations=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['guid'])) $this->guid = $o['guid'];
if (isset($o['number'])) $this->number = $o['number'];
if (isset($o['isCompleted'])) $this->isCompleted = $o['isCompleted'];
if (isset($o['completedDate'])) $this->completedDate = JsonConverters::from('DateTime', $o['completedDate']);
if (isset($o['address'])) $this->address = JsonConverters::from('Address', $o['address']);
if (isset($o['nutzeinheiten'])) $this->nutzeinheiten = JsonConverters::fromArray('Nutzeinheit', $o['nutzeinheiten']);
if (isset($o['billingInformations'])) $this->billingInformations = JsonConverters::fromArray('BillingInformation', $o['billingInformations']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->guid)) $o['guid'] = $this->guid;
if (isset($this->number)) $o['number'] = $this->number;
if (isset($this->isCompleted)) $o['isCompleted'] = $this->isCompleted;
if (isset($this->completedDate)) $o['completedDate'] = JsonConverters::to('DateTime', $this->completedDate);
if (isset($this->address)) $o['address'] = JsonConverters::to('Address', $this->address);
if (isset($this->nutzeinheiten)) $o['nutzeinheiten'] = JsonConverters::toArray('Nutzeinheit', $this->nutzeinheiten);
if (isset($this->billingInformations)) $o['billingInformations'] = JsonConverters::toArray('BillingInformation', $this->billingInformations);
return empty($o) ? new class(){} : $o;
}
}
class GetObjektResponse implements JsonSerializable
{
public function __construct(
/** @var Objekt|null */
public ?Objekt $objekt=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['objekt'])) $this->objekt = JsonConverters::from('Objekt', $o['objekt']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->objekt)) $o['objekt'] = JsonConverters::to('Objekt', $this->objekt);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
class GetObjekt 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='',
// @ApiMember(ParameterType="query")
/** @var string|null */
public ?string $include=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['bearerToken'])) $this->bearerToken = $o['bearerToken'];
if (isset($o['guid'])) $this->guid = $o['guid'];
if (isset($o['include'])) $this->include = $o['include'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->bearerToken)) $o['bearerToken'] = $this->bearerToken;
if (isset($this->guid)) $o['guid'] = $this->guid;
if (isset($this->include)) $o['include'] = $this->include;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/v1/objekte/{Guid} HTTP/1.1
Host: immo-account-servdesk.eras-online.de
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
objekt:
{
guid: 00000000000000000000000000000000,
number: String,
isCompleted: String,
completedDate: 0001-01-01T00:00:00Z,
address:
{
guid: 00000000000000000000000000000000,
street: String,
street2: String,
streetNumber: String,
zipcode: String,
city: String,
mailbox: String,
additional: String
},
nutzeinheiten:
[
{
guid: 00000000000000000000000000000000,
number: String,
location: String,
address:
{
guid: 00000000000000000000000000000000,
street: String,
street2: String,
streetNumber: String,
zipcode: String,
city: String,
mailbox: String,
additional: String
},
nutzer:
[
{
guid: 00000000000000000000000000000000,
name1: String,
name2: String,
name3: String,
name4: String,
nutzerType: Leerstand,
nutzeinheitNumberExternal: String,
nutzerInNutzeinheitSequence: 0,
rangeFrom: 0001-01-01T00:00:00Z,
rangeTo: 0001-01-01T00:00:00Z,
isDeleted: False,
isCreatedByApp: False,
IstUvi: String,
EigentuemerBewohnt: String,
Email: String,
Mobil: String,
title: String,
salutation: String
}
],
ownerNutzeinheiten:
[
{
guid: 00000000000000000000000000000000,
name1: String,
name2: String,
name3: String,
name4: String,
rangeFrom: 0001-01-01T00:00:00Z,
rangeTo: 0001-01-01T00:00:00Z,
title: String,
salutation: String,
address:
{
guid: 00000000000000000000000000000000,
street: String,
street2: String,
streetNumber: String,
zipcode: String,
city: String,
mailbox: String,
additional: String
}
}
],
nutzeinheitenDevices:
[
{
guid: 00000000000000000000000000000000,
assignedFromDate: 0001-01-01T00:00:00Z,
assignedToDate: 0001-01-01T00:00:00Z,
room: String,
ongoingNumber: String,
isRented: False,
isMaintained: False,
device:
{
guid: 00000000000000000000000000000000,
number: String,
label: String,
description: String,
installationDate: 0001-01-01T00:00:00Z,
deinstallationDate: 0001-01-01T00:00:00Z,
calibrationDate: 0001-01-01T00:00:00Z,
unit: L,
note: String,
deviceCatalog:
{
Guid: String,
TypKurz: String,
TypLang: String,
Ablesbar: False,
Klasse: String,
Abzug: False,
Hkvv: False,
Funk: False
},
deviceConsumptions:
[
{
guid: 00000000000000000000000000000000,
deviceReading: 0,
deviceReadingDate: 0001-01-01T00:00:00Z,
deviceReadingKind: ZA,
changeDate: 0001-01-01T00:00:00Z,
note: String,
ampouleColour: String,
deviceGuid: String
}
]
}
}
]
}
],
billingInformations:
[
{
guid: String,
from: 0001-01-01T00:00:00Z,
to: 0001-01-01T00:00:00Z,
isCompleted: False,
hasNebenkosten: False
}
]
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}