Server

<back to all web services

GetNutzeinheit

Nutzeinheiten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nutzeinheiten/{Guid}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetNutzeinheit : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null

    @ApiMember(IsRequired=true, ParameterType="path")
    var guid:UUID? = null

    @ApiMember(ParameterType="query")
    var include:String? = null
}

open class GetNutzeinheitResponse
{
    var nutzeinheit:Nutzeinheit? = null
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class Nutzeinheit
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var number:String? = null

    @DataMember
    var location:String? = null

    @DataMember
    var address:Address? = null

    @DataMember
    var nutzer:ArrayList<Nutzer> = ArrayList<Nutzer>()

    @DataMember
    var ownerNutzeinheiten:ArrayList<OwnerNutzeinheit> = ArrayList<OwnerNutzeinheit>()

    @DataMember
    var nutzeinheitenDevices:ArrayList<NutzeinheitDevice> = ArrayList<NutzeinheitDevice>()
}

@DataContract
open class Address
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var street:String? = null

    @DataMember
    var street2:String? = null

    @DataMember
    var streetNumber:String? = null

    @DataMember
    var zipcode:String? = null

    @DataMember
    var city:String? = null

    @DataMember
    var mailbox:String? = null

    @DataMember
    var additional:String? = null
}

@DataContract
open class Nutzer
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var name1:String? = null

    @DataMember
    var name2:String? = null

    @DataMember
    var name3:String? = null

    @DataMember
    var name4:String? = null

    @DataMember
    @ApiMember(IsRequired=true)
    var nutzerType:NutzerType? = null

    @DataMember
    var nutzeinheitNumberExternal:String? = null

    @DataMember
    @ApiMember(IsRequired=true)
    var nutzerInNutzeinheitSequence:Long? = null

    @DataMember
    @ApiMember(IsRequired=true)
    var rangeFrom:Date? = null

    @DataMember
    var rangeTo:Date? = null

    @DataMember
    var isDeleted:Boolean? = null

    @DataMember
    var isCreatedByApp:Boolean? = null

    @DataMember(Name="IstUvi")
    @SerializedName("IstUvi")
    var isUviRecieved:String? = null

    @DataMember(Name="EigentuemerBewohnt")
    @SerializedName("EigentuemerBewohnt")
    var isNutzerOwner:String? = null

    @DataMember(Name="Email")
    @SerializedName("Email")
    var email:String? = null

    @DataMember(Name="Mobil")
    @SerializedName("Mobil")
    var mobilePhone:String? = null

    @DataMember
    var title:String? = null

    @DataMember
    @ApiMember(IsRequired=true, ParameterType="body")
    var salutation:String? = null
}

enum class NutzerType
{
    Leerstand,
    Gewerblich,
    Privat,
    AllgemeineNutzung,
}

@DataContract
open class OwnerNutzeinheit
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:String? = null

    @DataMember(Name="Name1")
    @SerializedName("Name1")
    var name1:String? = null

    @DataMember(Name="Name2")
    @SerializedName("Name2")
    var name2:String? = null

    @DataMember(Name="Name3")
    @SerializedName("Name3")
    var name3:String? = null

    @DataMember(Name="Name4")
    @SerializedName("Name4")
    var name4:String? = null

    @DataMember(Name="ZeitraumVon")
    @SerializedName("ZeitraumVon")
    var rangeFrom:Date? = null

    @DataMember(Name="ZeitraumBis")
    @SerializedName("ZeitraumBis")
    var rangeTo:Date? = null

    @DataMember(Name="Titel")
    @SerializedName("Titel")
    var title:String? = null

    @DataMember(Name="Anrede")
    @SerializedName("Anrede")
    var salutation:String? = null

    @DataMember(Name="AdressGuid")
    @SerializedName("AdressGuid")
    var addressGuid:String? = null

    @DataMember(Name="NutzeinheitGuid")
    @SerializedName("NutzeinheitGuid")
    var nutzeinheitGuid:String? = null
}

@DataContract
open class NutzeinheitDevice
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:String? = null

    @DataMember(Name="ZuordnungVon")
    @SerializedName("ZuordnungVon")
    var assignedFromDate:Date? = null

    @DataMember(Name="ZuordnungBis")
    @SerializedName("ZuordnungBis")
    var assignedToDate:Date? = null

    @DataMember(Name="Raum")
    @SerializedName("Raum")
    var room:String? = null

    @DataMember(Name="LaufendeNummer")
    @SerializedName("LaufendeNummer")
    var ongoingNumber:String? = null

    @DataMember(Name="gemietet")
    @SerializedName("gemietet")
    var isRented:Boolean? = null

    @DataMember(Name="gewartet")
    @SerializedName("gewartet")
    var isMaintained:Boolean? = null

    @DataMember(Name="DeviceGuid")
    @SerializedName("DeviceGuid")
    var deviceGuid:String? = null

    @DataMember(Name="NutzeinheitGuid")
    @SerializedName("NutzeinheitGuid")
    var nutzeinheitGuid:String? = null
}

Kotlin 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: fairtherm-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"}}}