Server

<back to all web services

GetObjekt

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/{Guid}
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 Address:
    guid: Optional[str] = None
    street: Optional[str] = None
    street2: Optional[str] = None
    street_number: Optional[str] = None
    zipcode: Optional[str] = None
    city: Optional[str] = None
    mailbox: Optional[str] = None
    additional: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Nutzeinheit:
    guid: Optional[str] = None
    number: Optional[str] = None
    location: Optional[str] = None
    objekt_guid: Optional[str] = None
    address_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingInformation:
    guid: Optional[str] = None
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    is_completed: bool = False
    has_nebenkosten: bool = False
    objekt_guid: Optional[str] = None
    anmerkung_kundenportal: Optional[str] = None
    kundenportal_marked_done: bool = False
    marked_done_at: Optional[datetime.datetime] = None
    kundenportal_marked_closed: bool = False
    marked_closed_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Objekt:
    guid: Optional[str] = None
    number: Optional[str] = None
    is_completed: Optional[str] = None
    completed_date: Optional[datetime.datetime] = None
    address: Optional[Address] = None
    nutzeinheiten: Optional[List[Nutzeinheit]] = None
    billing_informations: Optional[List[BillingInformation]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjektResponse:
    objekt: Optional[Objekt] = None
    response_status: Optional[ResponseStatus] = None


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

    # @ApiMember(IsRequired=true, ParameterType="path")
    guid: Optional[str] = None

    # @ApiMember(ParameterType="query")
    include: Optional[str] = None

Python GetObjekt 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/objekte/{Guid} HTTP/1.1 
Host: marneth-messdienst-servdesk.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"objekt":{"guid":"00000000000000000000000000000000","number":"String","isCompleted":"String","completedDate":"0001-01-01T00:00:00.0000000Z","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:00.0000000Z","rangeTo":"0001-01-01T00:00:00.0000000Z","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:00.0000000Z","rangeTo":"0001-01-01T00:00:00.0000000Z","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:00.0000000Z","assignedToDate":"0001-01-01T00:00:00.0000000Z","room":"String","ongoingNumber":"String","isRented":false,"isMaintained":false,"device":{"guid":"00000000000000000000000000000000","number":"String","label":"String","description":"String","installationDate":"0001-01-01T00:00:00.0000000Z","deinstallationDate":"0001-01-01T00:00:00.0000000Z","calibrationDate":"0001-01-01T00:00:00.0000000Z","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:00.0000000Z","deviceReadingKind":"ZA","changeDate":"0001-01-01T00:00:00.0000000Z","note":"String","ampouleColour":"String","deviceGuid":"String"}]}}]}],"billingInformations":[{"guid":"String","from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z","isCompleted":false,"hasNebenkosten":false}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}