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 .other suffix or ?format=other

HTTP + OTHER

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: concept2021-servdesk.eras-online.de 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}