Server

<back to all web services

GetNutzeinheit

Nutzeinheiten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzeinheiten/{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


class NutzerType(str, Enum):
    LEERSTAND = 'Leerstand'
    GEWERBLICH = 'Gewerblich'
    PRIVAT = 'Privat'
    ALLGEMEINE_NUTZUNG = 'AllgemeineNutzung'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Nutzer:
    guid: Optional[str] = None
    name1: Optional[str] = None
    name2: Optional[str] = None
    name3: Optional[str] = None
    name4: Optional[str] = None
    # @ApiMember(IsRequired=true)
    nutzer_type: Optional[NutzerType] = None

    nutzeinheit_number_external: Optional[str] = None
    # @ApiMember(IsRequired=true)
    nutzer_in_nutzeinheit_sequence: int = 0

    # @ApiMember(IsRequired=true)
    range_from: datetime.datetime = datetime.datetime(1, 1, 1)

    range_to: Optional[datetime.datetime] = None
    is_deleted: bool = False
    is_created_by_app: bool = False
    is_uvi_recieved: Optional[str] = None
    is_nutzer_owner: Optional[str] = None
    email: Optional[str] = None
    mobile_phone: Optional[str] = None
    title: Optional[str] = None
    # @ApiMember(IsRequired=true, ParameterType="body")
    salutation: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerNutzeinheit:
    guid: Optional[str] = None
    name1: Optional[str] = None
    name2: Optional[str] = None
    name3: Optional[str] = None
    name4: Optional[str] = None
    range_from: datetime.datetime = datetime.datetime(1, 1, 1)
    range_to: Optional[datetime.datetime] = None
    title: Optional[str] = None
    salutation: Optional[str] = None
    address_guid: Optional[str] = None
    nutzeinheit_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NutzeinheitDevice:
    guid: Optional[str] = None
    assigned_from_date: datetime.datetime = datetime.datetime(1, 1, 1)
    assigned_to_date: Optional[datetime.datetime] = None
    room: Optional[str] = None
    ongoing_number: Optional[str] = None
    is_rented: bool = False
    is_maintained: bool = False
    device_guid: Optional[str] = None
    nutzeinheit_guid: 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
    address: Optional[Address] = None
    nutzer: Optional[List[Nutzer]] = None
    owner_nutzeinheiten: Optional[List[OwnerNutzeinheit]] = None
    nutzeinheiten_devices: Optional[List[NutzeinheitDevice]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetNutzeinheitResponse:
    nutzeinheit: Optional[Nutzeinheit] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetNutzeinheit(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 GetNutzeinheit 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/nutzeinheiten/{Guid} HTTP/1.1 
Host: messtecc-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNutzeinheitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Nutzeinheit xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Address>
      <d2p1:Additional>String</d2p1:Additional>
      <d2p1:City>String</d2p1:City>
      <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
      <d2p1:Mailbox>String</d2p1:Mailbox>
      <d2p1:Street>String</d2p1:Street>
      <d2p1:Street2>String</d2p1:Street2>
      <d2p1:StreetNumber>String</d2p1:StreetNumber>
      <d2p1:Zipcode>String</d2p1:Zipcode>
    </d2p1:Address>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:Number>String</d2p1:Number>
    <d2p1:NutzeinheitenDevices>
      <d2p1:NutzeinheitDevice>
        <d2p1:AssignedFromDate>0001-01-01T00:00:00</d2p1:AssignedFromDate>
        <d2p1:AssignedToDate>0001-01-01T00:00:00</d2p1:AssignedToDate>
        <d2p1:Device>
          <d2p1:CalibrationDate>0001-01-01T00:00:00</d2p1:CalibrationDate>
          <d2p1:DeinstallationDate>0001-01-01T00:00:00</d2p1:DeinstallationDate>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:DeviceCatalog xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten">
            <d6p1:Ablesbar>false</d6p1:Ablesbar>
            <d6p1:Abzug>false</d6p1:Abzug>
            <d6p1:Funk>false</d6p1:Funk>
            <d6p1:Guid>String</d6p1:Guid>
            <d6p1:Hkvv>false</d6p1:Hkvv>
            <d6p1:Klasse>String</d6p1:Klasse>
            <d6p1:TypKurz>String</d6p1:TypKurz>
            <d6p1:TypLang>String</d6p1:TypLang>
          </d2p1:DeviceCatalog>
          <d2p1:DeviceConsumptions>
            <d2p1:DeviceConsumption>
              <d2p1:AmpouleColour>String</d2p1:AmpouleColour>
              <d2p1:ChangeDate>0001-01-01T00:00:00</d2p1:ChangeDate>
              <d2p1:DeviceGuid>String</d2p1:DeviceGuid>
              <d2p1:DeviceReading>0</d2p1:DeviceReading>
              <d2p1:DeviceReadingDate>0001-01-01T00:00:00</d2p1:DeviceReadingDate>
              <d2p1:DeviceReadingKind>ZA</d2p1:DeviceReadingKind>
              <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
              <d2p1:Note>String</d2p1:Note>
            </d2p1:DeviceConsumption>
          </d2p1:DeviceConsumptions>
          <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
          <d2p1:InstallationDate>0001-01-01T00:00:00</d2p1:InstallationDate>
          <d2p1:Label>String</d2p1:Label>
          <d2p1:Note>String</d2p1:Note>
          <d2p1:Number>String</d2p1:Number>
          <d2p1:Unit>L</d2p1:Unit>
        </d2p1:Device>
        <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
        <d2p1:IsMaintained>false</d2p1:IsMaintained>
        <d2p1:IsRented>false</d2p1:IsRented>
        <d2p1:OngoingNumber>String</d2p1:OngoingNumber>
        <d2p1:Room>String</d2p1:Room>
      </d2p1:NutzeinheitDevice>
    </d2p1:NutzeinheitenDevices>
    <d2p1:Nutzer>
      <d2p1:Nutzer>
        <d2p1:EigentuemerBewohnt>String</d2p1:EigentuemerBewohnt>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
        <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:IstUvi>String</d2p1:IstUvi>
        <d2p1:Mobil>String</d2p1:Mobil>
        <d2p1:Name1>String</d2p1:Name1>
        <d2p1:Name2>String</d2p1:Name2>
        <d2p1:Name3>String</d2p1:Name3>
        <d2p1:Name4>String</d2p1:Name4>
        <d2p1:NutzeinheitNumberExternal>String</d2p1:NutzeinheitNumberExternal>
        <d2p1:NutzerInNutzeinheitSequence>0</d2p1:NutzerInNutzeinheitSequence>
        <d2p1:NutzerType>Leerstand</d2p1:NutzerType>
        <d2p1:RangeFrom>0001-01-01T00:00:00</d2p1:RangeFrom>
        <d2p1:RangeTo>0001-01-01T00:00:00</d2p1:RangeTo>
        <d2p1:Salutation>String</d2p1:Salutation>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:Nutzer>
    </d2p1:Nutzer>
    <d2p1:OwnerNutzeinheiten>
      <d2p1:OwnerNutzeinheit>
        <d2p1:Address>
          <d2p1:Additional>String</d2p1:Additional>
          <d2p1:City>String</d2p1:City>
          <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
          <d2p1:Mailbox>String</d2p1:Mailbox>
          <d2p1:Street>String</d2p1:Street>
          <d2p1:Street2>String</d2p1:Street2>
          <d2p1:StreetNumber>String</d2p1:StreetNumber>
          <d2p1:Zipcode>String</d2p1:Zipcode>
        </d2p1:Address>
        <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
        <d2p1:Name1>String</d2p1:Name1>
        <d2p1:Name2>String</d2p1:Name2>
        <d2p1:Name3>String</d2p1:Name3>
        <d2p1:Name4>String</d2p1:Name4>
        <d2p1:RangeFrom>0001-01-01T00:00:00</d2p1:RangeFrom>
        <d2p1:RangeTo>0001-01-01T00:00:00</d2p1:RangeTo>
        <d2p1:Salutation>String</d2p1:Salutation>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:OwnerNutzeinheit>
    </d2p1:OwnerNutzeinheiten>
  </Nutzeinheit>
  <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>
</GetNutzeinheitResponse>