Server

<back to all web services

GetObjekt

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/{Guid}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
class Address implements IConvertible
{
    // @DataMember
    String? guid;

    // @DataMember
    String? street;

    // @DataMember
    String? street2;

    // @DataMember
    String? streetNumber;

    // @DataMember
    String? zipcode;

    // @DataMember
    String? city;

    // @DataMember
    String? mailbox;

    // @DataMember
    String? additional;

    Address({this.guid,this.street,this.street2,this.streetNumber,this.zipcode,this.city,this.mailbox,this.additional});
    Address.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        guid = json['guid'];
        street = json['street'];
        street2 = json['street2'];
        streetNumber = json['streetNumber'];
        zipcode = json['zipcode'];
        city = json['city'];
        mailbox = json['mailbox'];
        additional = json['additional'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': guid,
        'street': street,
        'street2': street2,
        'streetNumber': streetNumber,
        'zipcode': zipcode,
        'city': city,
        'mailbox': mailbox,
        'additional': additional
    };

    getTypeName() => "Address";
    TypeContext? context = _ctx;
}

// @DataContract
class Nutzeinheit implements IConvertible
{
    // @DataMember(Name="Guid")
    String? Guid;

    // @DataMember(Name="Nummer")
    String? Nummer;

    // @DataMember(Name="Lage")
    String? Lage;

    // @DataMember(Name="ObjektGuid")
    String? ObjektGuid;

    // @DataMember(Name="AdressGuid")
    String? AdressGuid;

    Nutzeinheit({this.Guid,this.Nummer,this.Lage,this.ObjektGuid,this.AdressGuid});
    Nutzeinheit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Guid = json['guid'];
        Nummer = json['number'];
        Lage = json['location'];
        ObjektGuid = json['objektGuid'];
        AdressGuid = json['addressGuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': Guid,
        'nummer': Nummer,
        'lage': Lage,
        'objektGuid': ObjektGuid,
        'adressGuid': AdressGuid
    };

    getTypeName() => "Nutzeinheit";
    TypeContext? context = _ctx;
}

// @DataContract
class BillingInformation implements IConvertible
{
    // @DataMember(Name="Guid")
    String? Guid;

    // @DataMember(Name="Von")
    DateTime? Von;

    // @DataMember(Name="Bis")
    DateTime? Bis;

    // @DataMember(Name="IstAbgeschlossen")
    bool? IstAbgeschlossen;

    // @DataMember(Name="HatNebenkosten")
    bool? HatNebenkosten;

    // @DataMember(Name="ObjektGuid")
    String? ObjektGuid;

    // @DataMember(Name="AnmerkungKundenportal")
    String? AnmerkungKundenportal;

    // @DataMember(Name="KundenportalMarkedDone")
    bool? KundenportalMarkedDone;

    // @DataMember(Name="MarkedDoneAt")
    DateTime? MarkedDoneAt;

    // @DataMember(Name="KundenportalMarkedClosed")
    bool? KundenportalMarkedClosed;

    // @DataMember(Name="MarkedClosedAt")
    DateTime? MarkedClosedAt;

    BillingInformation({this.Guid,this.Von,this.Bis,this.IstAbgeschlossen,this.HatNebenkosten,this.ObjektGuid,this.AnmerkungKundenportal,this.KundenportalMarkedDone,this.MarkedDoneAt,this.KundenportalMarkedClosed,this.MarkedClosedAt});
    BillingInformation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Guid = json['guid'];
        Von = JsonConverters.fromJson(json['from'],'DateTime',context!);
        Bis = JsonConverters.fromJson(json['to'],'DateTime',context!);
        IstAbgeschlossen = json['isCompleted'];
        HatNebenkosten = json['hasNebenkosten'];
        ObjektGuid = json['objektGuid'];
        AnmerkungKundenportal = json['anmerkungKundenportal'];
        KundenportalMarkedDone = json['kundenportalMarkedDone'];
        MarkedDoneAt = JsonConverters.fromJson(json['markedDoneAt'],'DateTime',context!);
        KundenportalMarkedClosed = json['kundenportalMarkedClosed'];
        MarkedClosedAt = JsonConverters.fromJson(json['markedClosedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': Guid,
        'von': JsonConverters.toJson(Von,'DateTime',context!),
        'bis': JsonConverters.toJson(Bis,'DateTime',context!),
        'istAbgeschlossen': IstAbgeschlossen,
        'hatNebenkosten': HatNebenkosten,
        'objektGuid': ObjektGuid,
        'anmerkungKundenportal': AnmerkungKundenportal,
        'kundenportalMarkedDone': KundenportalMarkedDone,
        'markedDoneAt': JsonConverters.toJson(MarkedDoneAt,'DateTime',context!),
        'kundenportalMarkedClosed': KundenportalMarkedClosed,
        'markedClosedAt': JsonConverters.toJson(MarkedClosedAt,'DateTime',context!)
    };

    getTypeName() => "BillingInformation";
    TypeContext? context = _ctx;
}

// @DataContract
class Objekt implements IConvertible
{
    // @DataMember
    String? guid;

    // @DataMember
    String? number;

    // @DataMember
    String? isCompleted;

    // @DataMember
    DateTime? completedDate;

    // @DataMember
    Address? address;

    // @DataMember
    List<Nutzeinheit>? nutzeinheiten;

    // @DataMember
    List<BillingInformation>? billingInformations;

    Objekt({this.guid,this.number,this.isCompleted,this.completedDate,this.address,this.nutzeinheiten,this.billingInformations});
    Objekt.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        guid = json['guid'];
        number = json['number'];
        isCompleted = json['isCompleted'];
        completedDate = JsonConverters.fromJson(json['completedDate'],'DateTime',context!);
        address = JsonConverters.fromJson(json['address'],'Address',context!);
        nutzeinheiten = JsonConverters.fromJson(json['nutzeinheiten'],'List<Nutzeinheit>',context!);
        billingInformations = JsonConverters.fromJson(json['billingInformations'],'List<BillingInformation>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': guid,
        'number': number,
        'isCompleted': isCompleted,
        'completedDate': JsonConverters.toJson(completedDate,'DateTime',context!),
        'address': JsonConverters.toJson(address,'Address',context!),
        'nutzeinheiten': JsonConverters.toJson(nutzeinheiten,'List<Nutzeinheit>',context!),
        'billingInformations': JsonConverters.toJson(billingInformations,'List<BillingInformation>',context!)
    };

    getTypeName() => "Objekt";
    TypeContext? context = _ctx;
}

class GetObjektResponse implements IConvertible
{
    Objekt? objekt;
    ResponseStatus? responseStatus;

    GetObjektResponse({this.objekt,this.responseStatus});
    GetObjektResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        objekt = JsonConverters.fromJson(json['objekt'],'Objekt',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'objekt': JsonConverters.toJson(objekt,'Objekt',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetObjektResponse";
    TypeContext? context = _ctx;
}

class GetObjekt implements IHasBearerToken, IConvertible
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    String? bearerToken;

    // @ApiMember(IsRequired=true, ParameterType="path")
    String? guid;

    // @ApiMember(ParameterType="query")
    String? include;

    GetObjekt({this.bearerToken,this.guid,this.include});
    GetObjekt.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        bearerToken = json['bearerToken'];
        guid = json['guid'];
        include = json['include'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'bearerToken': bearerToken,
        'guid': guid,
        'include': include
    };

    getTypeName() => "GetObjekt";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'mitchell_servdesk.eras_online.de', types: <String, TypeInfo> {
    'Address': TypeInfo(TypeOf.Class, create:() => Address()),
    'Nutzeinheit': TypeInfo(TypeOf.Class, create:() => Nutzeinheit()),
    'BillingInformation': TypeInfo(TypeOf.Class, create:() => BillingInformation()),
    'Objekt': TypeInfo(TypeOf.Class, create:() => Objekt()),
    'List<Nutzeinheit>': TypeInfo(TypeOf.Class, create:() => <Nutzeinheit>[]),
    'List<BillingInformation>': TypeInfo(TypeOf.Class, create:() => <BillingInformation>[]),
    'GetObjektResponse': TypeInfo(TypeOf.Class, create:() => GetObjektResponse()),
    'GetObjekt': TypeInfo(TypeOf.Class, create:() => GetObjekt()),
});

Dart GetObjekt 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/objekte/{Guid} HTTP/1.1 
Host: mitchell-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjektResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Objekt 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:BillingInformations>
      <d2p1:BillingInformation>
        <d2p1:From>0001-01-01T00:00:00</d2p1:From>
        <d2p1:Guid>String</d2p1:Guid>
        <d2p1:HasNebenkosten>false</d2p1:HasNebenkosten>
        <d2p1:IsCompleted>false</d2p1:IsCompleted>
        <d2p1:To>0001-01-01T00:00:00</d2p1:To>
      </d2p1:BillingInformation>
    </d2p1:BillingInformations>
    <d2p1:CompletedDate>0001-01-01T00:00:00</d2p1:CompletedDate>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:IsCompleted>String</d2p1:IsCompleted>
    <d2p1:Number>String</d2p1:Number>
    <d2p1:Nutzeinheiten>
      <d2p1:Nutzeinheit>
        <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:d8p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten">
                <d8p1:Ablesbar>false</d8p1:Ablesbar>
                <d8p1:Abzug>false</d8p1:Abzug>
                <d8p1:Funk>false</d8p1:Funk>
                <d8p1:Guid>String</d8p1:Guid>
                <d8p1:Hkvv>false</d8p1:Hkvv>
                <d8p1:Klasse>String</d8p1:Klasse>
                <d8p1:TypKurz>String</d8p1:TypKurz>
                <d8p1:TypLang>String</d8p1: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>
      </d2p1:Nutzeinheit>
    </d2p1:Nutzeinheiten>
  </Objekt>
  <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>
</GetObjektResponse>