Server

GetObjekt

Objekte

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

        <DataContract>
        Public Partial Class BillingInformation
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As String

            <DataMember(Name:="Von")>
            Public Overridable Property From As Date

            <DataMember(Name:="Bis")>
            Public Overridable Property To As Date

            <DataMember(Name:="IstAbgeschlossen")>
            Public Overridable Property IsCompleted As Boolean

            <DataMember(Name:="HatNebenkosten")>
            Public Overridable Property HasNebenkosten As Boolean

            <DataMember(Name:="ObjektGuid")>
            Public Overridable Property ObjektGuid As String

            <DataMember(Name:="AnmerkungKundenportal")>
            Public Overridable Property AnmerkungKundenportal As String

            <DataMember(Name:="KundenportalMarkedDone")>
            Public Overridable Property KundenportalMarkedDone As Boolean

            <DataMember(Name:="MarkedDoneAt")>
            Public Overridable Property MarkedDoneAt As Nullable(Of Date)

            <DataMember(Name:="KundenportalMarkedClosed")>
            Public Overridable Property KundenportalMarkedClosed As Boolean

            <DataMember(Name:="MarkedClosedAt")>
            Public Overridable Property MarkedClosedAt As Nullable(Of Date)
        End Class

        <DataContract>
        Public Partial Class Nutzeinheit
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As String

            <DataMember(Name:="Nummer")>
            Public Overridable Property Number As String

            <DataMember(Name:="Lage")>
            Public Overridable Property Location As String

            <DataMember(Name:="ObjektGuid")>
            Public Overridable Property ObjektGuid As String

            <DataMember(Name:="AdressGuid")>
            Public Overridable Property AddressGuid As String
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetObjekt
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            <ApiMember(IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Guid As Guid

            <ApiMember(ParameterType:="query")>
            Public Overridable Property Include As String
        End Class

        Public Partial Class GetObjektResponse
            Public Overridable Property Objekt As Objekt
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models

        <DataContract>
        Public Partial Class Address
            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property Street As String

            <DataMember>
            Public Overridable Property Street2 As String

            <DataMember>
            Public Overridable Property StreetNumber As String

            <DataMember>
            Public Overridable Property Zipcode As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property Mailbox As String

            <DataMember>
            Public Overridable Property Additional As String
        End Class

        <DataContract>
        Public Partial Class Objekt
            Public Sub New()
                Nutzeinheiten = New List(Of Nutzeinheit)
                BillingInformations = New List(Of BillingInformation)
            End Sub

            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property Number As String

            <DataMember>
            Public Overridable Property IsCompleted As String

            <DataMember>
            Public Overridable Property CompletedDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property Address As Address

            <DataMember>
            Public Overridable Property Nutzeinheiten As List(Of Nutzeinheit)

            <DataMember>
            Public Overridable Property BillingInformations As List(Of BillingInformation)
        End Class
    End Namespace
End Namespace

VB.NET 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: depolt-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>