Server

<back to all web services

GetObjekt

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


open class GetObjekt : 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 GetObjektResponse
{
    var objekt:Objekt? = null
    var responseStatus:ResponseStatus? = null
}

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

    @DataMember
    var number:String? = null

    @DataMember
    var isCompleted:String? = null

    @DataMember
    var completedDate:Date? = null

    @DataMember
    var address:Address? = null

    @DataMember
    var nutzeinheiten:ArrayList<Nutzeinheit> = ArrayList<Nutzeinheit>()

    @DataMember
    var billingInformations:ArrayList<BillingInformation> = ArrayList<BillingInformation>()
}

@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 Nutzeinheit
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:String? = null

    @DataMember(Name="Nummer")
    @SerializedName("Nummer")
    var number:String? = null

    @DataMember(Name="Lage")
    @SerializedName("Lage")
    var location:String? = null

    @DataMember(Name="ObjektGuid")
    @SerializedName("ObjektGuid")
    var objektGuid:String? = null

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

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

    @DataMember(Name="Von")
    @SerializedName("Von")
    var from:Date? = null

    @DataMember(Name="Bis")
    @SerializedName("Bis")
    var to:Date? = null

    @DataMember(Name="IstAbgeschlossen")
    @SerializedName("IstAbgeschlossen")
    var isCompleted:Boolean? = null

    @DataMember(Name="HatNebenkosten")
    @SerializedName("HatNebenkosten")
    var hasNebenkosten:Boolean? = null

    @DataMember(Name="ObjektGuid")
    @SerializedName("ObjektGuid")
    var objektGuid:String? = null

    @DataMember(Name="AnmerkungKundenportal")
    @SerializedName("AnmerkungKundenportal")
    var anmerkungKundenportal:String? = null

    @DataMember(Name="KundenportalMarkedDone")
    @SerializedName("KundenportalMarkedDone")
    var kundenportalMarkedDone:Boolean? = null

    @DataMember(Name="MarkedDoneAt")
    @SerializedName("MarkedDoneAt")
    var markedDoneAt:Date? = null

    @DataMember(Name="KundenportalMarkedClosed")
    @SerializedName("KundenportalMarkedClosed")
    var kundenportalMarkedClosed:Boolean? = null

    @DataMember(Name="MarkedClosedAt")
    @SerializedName("MarkedClosedAt")
    var markedClosedAt:Date? = null
}

Kotlin GetObjekt DTOs

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

HTTP + CSV

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: elotesch-servdesk.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}