Server

<back to all web services

GetNutzeinheit

Nutzeinheiten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzeinheiten/{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.Enums
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

        Public Enum NutzerType
            Leerstand
            Gewerblich
            Privat
            AllgemeineNutzung
        End Enum
    End Namespace

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

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

            <DataMember(Name:="ZuordnungVon")>
            Public Overridable Property AssignedFromDate As Date

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

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

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

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

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

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

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

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

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

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

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

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

            <DataMember(Name:="ZeitraumVon")>
            Public Overridable Property RangeFrom As Date

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

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

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

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

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

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

        Public Partial Class GetNutzeinheit
            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 GetNutzeinheitResponse
            Public Overridable Property Nutzeinheit As Nutzeinheit
            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 Nutzeinheit
            Public Sub New()
                Nutzer = New List(Of Nutzer)
                OwnerNutzeinheiten = New List(Of OwnerNutzeinheit)
                NutzeinheitenDevices = New List(Of NutzeinheitDevice)
            End Sub

            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property Number As String

            <DataMember>
            Public Overridable Property Location As String

            <DataMember>
            Public Overridable Property Address As Address

            <DataMember>
            Public Overridable Property Nutzer As List(Of Nutzer)

            <DataMember>
            Public Overridable Property OwnerNutzeinheiten As List(Of OwnerNutzeinheit)

            <DataMember>
            Public Overridable Property NutzeinheitenDevices As List(Of NutzeinheitDevice)
        End Class

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

            <DataMember>
            Public Overridable Property Name1 As String

            <DataMember>
            Public Overridable Property Name2 As String

            <DataMember>
            Public Overridable Property Name3 As String

            <DataMember>
            Public Overridable Property Name4 As String

            <DataMember>
            <ApiMember(IsRequired:=true)>
            Public Overridable Property NutzerType As Nullable(Of NutzerType)

            <DataMember>
            Public Overridable Property NutzeinheitNumberExternal As String

            <DataMember>
            <ApiMember(IsRequired:=true)>
            Public Overridable Property NutzerInNutzeinheitSequence As UInt32

            <DataMember>
            <ApiMember(IsRequired:=true)>
            Public Overridable Property RangeFrom As Date

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

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

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

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

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

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

            <DataMember>
            Public Overridable Property Title As String

            <DataMember>
            <ApiMember(IsRequired:=true, ParameterType:="body")>
            Public Overridable Property Salutation As String
        End Class
    End Namespace
End Namespace

VB.NET GetNutzeinheit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: heat-syke-servdesk.eras-online.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"nutzeinheit":{"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"}]}}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}