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.*;

public class dtos
{

    public static class GetObjekt implements IHasBearerToken
    {
        @ApiMember(IsRequired=true, ParameterType="query")
        public String bearerToken = null;

        @ApiMember(IsRequired=true, ParameterType="path")
        public UUID guid = null;

        @ApiMember(ParameterType="query")
        public String include = null;
        
        public String getBearerToken() { return bearerToken; }
        public GetObjekt setBearerToken(String value) { this.bearerToken = value; return this; }
        public UUID getGuid() { return guid; }
        public GetObjekt setGuid(UUID value) { this.guid = value; return this; }
        public String getInclude() { return include; }
        public GetObjekt setInclude(String value) { this.include = value; return this; }
    }

    public static class GetObjektResponse
    {
        public Objekt objekt = null;
        public ResponseStatus responseStatus = null;
        
        public Objekt getObjekt() { return objekt; }
        public GetObjektResponse setObjekt(Objekt value) { this.objekt = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetObjektResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class Objekt
    {
        @DataMember
        public UUID guid = null;

        @DataMember
        public String number = null;

        @DataMember
        public String isCompleted = null;

        @DataMember
        public Date completedDate = null;

        @DataMember
        public Address address = null;

        @DataMember
        public ArrayList<Nutzeinheit> nutzeinheiten = null;

        @DataMember
        public ArrayList<BillingInformation> billingInformations = null;
        
        public UUID getGuid() { return guid; }
        public Objekt setGuid(UUID value) { this.guid = value; return this; }
        public String getNumber() { return number; }
        public Objekt setNumber(String value) { this.number = value; return this; }
        public String getIsCompleted() { return isCompleted; }
        public Objekt setIsCompleted(String value) { this.isCompleted = value; return this; }
        public Date getCompletedDate() { return completedDate; }
        public Objekt setCompletedDate(Date value) { this.completedDate = value; return this; }
        public Address getAddress() { return address; }
        public Objekt setAddress(Address value) { this.address = value; return this; }
        public ArrayList<Nutzeinheit> getNutzeinheiten() { return nutzeinheiten; }
        public Objekt setNutzeinheiten(ArrayList<Nutzeinheit> value) { this.nutzeinheiten = value; return this; }
        public ArrayList<BillingInformation> getBillingInformations() { return billingInformations; }
        public Objekt setBillingInformations(ArrayList<BillingInformation> value) { this.billingInformations = value; return this; }
    }

    @DataContract
    public static class Address
    {
        @DataMember
        public UUID guid = null;

        @DataMember
        public String street = null;

        @DataMember
        public String street2 = null;

        @DataMember
        public String streetNumber = null;

        @DataMember
        public String zipcode = null;

        @DataMember
        public String city = null;

        @DataMember
        public String mailbox = null;

        @DataMember
        public String additional = null;
        
        public UUID getGuid() { return guid; }
        public Address setGuid(UUID value) { this.guid = value; return this; }
        public String getStreet() { return street; }
        public Address setStreet(String value) { this.street = value; return this; }
        public String getStreet2() { return street2; }
        public Address setStreet2(String value) { this.street2 = value; return this; }
        public String getStreetNumber() { return streetNumber; }
        public Address setStreetNumber(String value) { this.streetNumber = value; return this; }
        public String getZipcode() { return zipcode; }
        public Address setZipcode(String value) { this.zipcode = value; return this; }
        public String getCity() { return city; }
        public Address setCity(String value) { this.city = value; return this; }
        public String getMailbox() { return mailbox; }
        public Address setMailbox(String value) { this.mailbox = value; return this; }
        public String getAdditional() { return additional; }
        public Address setAdditional(String value) { this.additional = value; return this; }
    }

    @DataContract
    public static class Nutzeinheit
    {
        @DataMember(Name="Guid")
        @SerializedName("Guid")
        public String guid = null;

        @DataMember(Name="Nummer")
        @SerializedName("Nummer")
        public String number = null;

        @DataMember(Name="Lage")
        @SerializedName("Lage")
        public String location = null;

        @DataMember(Name="ObjektGuid")
        @SerializedName("ObjektGuid")
        public String objektGuid = null;

        @DataMember(Name="AdressGuid")
        @SerializedName("AdressGuid")
        public String addressGuid = null;
        
        public String getGuid() { return guid; }
        public Nutzeinheit setGuid(String value) { this.guid = value; return this; }
        public String getNumber() { return number; }
        public Nutzeinheit setNumber(String value) { this.number = value; return this; }
        public String getLocation() { return location; }
        public Nutzeinheit setLocation(String value) { this.location = value; return this; }
        public String getObjektGuid() { return objektGuid; }
        public Nutzeinheit setObjektGuid(String value) { this.objektGuid = value; return this; }
        public String getAddressGuid() { return addressGuid; }
        public Nutzeinheit setAddressGuid(String value) { this.addressGuid = value; return this; }
    }

    @DataContract
    public static class BillingInformation
    {
        @DataMember(Name="Guid")
        @SerializedName("Guid")
        public String guid = null;

        @DataMember(Name="Von")
        @SerializedName("Von")
        public Date from = null;

        @DataMember(Name="Bis")
        @SerializedName("Bis")
        public Date to = null;

        @DataMember(Name="IstAbgeschlossen")
        @SerializedName("IstAbgeschlossen")
        public Boolean isCompleted = null;

        @DataMember(Name="HatNebenkosten")
        @SerializedName("HatNebenkosten")
        public Boolean hasNebenkosten = null;

        @DataMember(Name="ObjektGuid")
        @SerializedName("ObjektGuid")
        public String objektGuid = null;

        @DataMember(Name="AnmerkungKundenportal")
        @SerializedName("AnmerkungKundenportal")
        public String anmerkungKundenportal = null;

        @DataMember(Name="KundenportalMarkedDone")
        @SerializedName("KundenportalMarkedDone")
        public Boolean kundenportalMarkedDone = null;

        @DataMember(Name="MarkedDoneAt")
        @SerializedName("MarkedDoneAt")
        public Date markedDoneAt = null;

        @DataMember(Name="KundenportalMarkedClosed")
        @SerializedName("KundenportalMarkedClosed")
        public Boolean kundenportalMarkedClosed = null;

        @DataMember(Name="MarkedClosedAt")
        @SerializedName("MarkedClosedAt")
        public Date markedClosedAt = null;
        
        public String getGuid() { return guid; }
        public BillingInformation setGuid(String value) { this.guid = value; return this; }
        public Date getFrom() { return from; }
        public BillingInformation setFrom(Date value) { this.from = value; return this; }
        public Date getTo() { return to; }
        public BillingInformation setTo(Date value) { this.to = value; return this; }
        public Boolean getIsCompleted() { return isCompleted; }
        public BillingInformation setIsCompleted(Boolean value) { this.isCompleted = value; return this; }
        public Boolean isHasNebenkosten() { return hasNebenkosten; }
        public BillingInformation setHasNebenkosten(Boolean value) { this.hasNebenkosten = value; return this; }
        public String getObjektGuid() { return objektGuid; }
        public BillingInformation setObjektGuid(String value) { this.objektGuid = value; return this; }
        public String getAnmerkungKundenportal() { return anmerkungKundenportal; }
        public BillingInformation setAnmerkungKundenportal(String value) { this.anmerkungKundenportal = value; return this; }
        public Boolean isKundenportalMarkedDone() { return kundenportalMarkedDone; }
        public BillingInformation setKundenportalMarkedDone(Boolean value) { this.kundenportalMarkedDone = value; return this; }
        public Date getMarkedDoneAt() { return markedDoneAt; }
        public BillingInformation setMarkedDoneAt(Date value) { this.markedDoneAt = value; return this; }
        public Boolean isKundenportalMarkedClosed() { return kundenportalMarkedClosed; }
        public BillingInformation setKundenportalMarkedClosed(Boolean value) { this.kundenportalMarkedClosed = value; return this; }
        public Date getMarkedClosedAt() { return markedClosedAt; }
        public BillingInformation setMarkedClosedAt(Date value) { this.markedClosedAt = value; return this; }
    }

}

Java 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: dumpro-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"}}}