Server

<back to all web services

GetObjekt

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/{Guid}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models;

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2Client.Models
{
    [DataContract]
    public partial class BillingInformation
    {
        [DataMember(Name="Guid")]
        public virtual string Guid { get; set; }

        [DataMember(Name="Von")]
        public virtual DateTime From { get; set; }

        [DataMember(Name="Bis")]
        public virtual DateTime To { get; set; }

        [DataMember(Name="IstAbgeschlossen")]
        public virtual bool IsCompleted { get; set; }

        [DataMember(Name="HatNebenkosten")]
        public virtual bool HasNebenkosten { get; set; }

        [DataMember(Name="ObjektGuid")]
        public virtual string ObjektGuid { get; set; }

        [DataMember(Name="AnmerkungKundenportal")]
        public virtual string AnmerkungKundenportal { get; set; }

        [DataMember(Name="KundenportalMarkedDone")]
        public virtual bool KundenportalMarkedDone { get; set; }

        [DataMember(Name="MarkedDoneAt")]
        public virtual DateTime? MarkedDoneAt { get; set; }

        [DataMember(Name="KundenportalMarkedClosed")]
        public virtual bool KundenportalMarkedClosed { get; set; }

        [DataMember(Name="MarkedClosedAt")]
        public virtual DateTime? MarkedClosedAt { get; set; }
    }

    [DataContract]
    public partial class Nutzeinheit
    {
        [DataMember(Name="Guid")]
        public virtual string Guid { get; set; }

        [DataMember(Name="Nummer")]
        public virtual string Number { get; set; }

        [DataMember(Name="Lage")]
        public virtual string Location { get; set; }

        [DataMember(Name="ObjektGuid")]
        public virtual string ObjektGuid { get; set; }

        [DataMember(Name="AdressGuid")]
        public virtual string AddressGuid { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
{
    public partial class GetObjekt
        : IHasBearerToken
    {
        [ApiMember(IsRequired=true, ParameterType="query")]
        public virtual string BearerToken { get; set; }

        [ApiMember(IsRequired=true, ParameterType="path")]
        public virtual Guid Guid { get; set; }

        [ApiMember(ParameterType="query")]
        public virtual string Include { get; set; }
    }

    public partial class GetObjektResponse
    {
        public virtual Objekt Objekt { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
{
    [DataContract]
    public partial class Address
    {
        [DataMember]
        public virtual Guid Guid { get; set; }

        [DataMember]
        public virtual string Street { get; set; }

        [DataMember]
        public virtual string Street2 { get; set; }

        [DataMember]
        public virtual string StreetNumber { get; set; }

        [DataMember]
        public virtual string Zipcode { get; set; }

        [DataMember]
        public virtual string City { get; set; }

        [DataMember]
        public virtual string Mailbox { get; set; }

        [DataMember]
        public virtual string Additional { get; set; }
    }

    [DataContract]
    public partial class Objekt
    {
        public Objekt()
        {
            Nutzeinheiten = new List<Nutzeinheit>{};
            BillingInformations = new List<BillingInformation>{};
        }

        [DataMember]
        public virtual Guid Guid { get; set; }

        [DataMember]
        public virtual string Number { get; set; }

        [DataMember]
        public virtual string IsCompleted { get; set; }

        [DataMember]
        public virtual DateTime? CompletedDate { get; set; }

        [DataMember]
        public virtual Address Address { get; set; }

        [DataMember]
        public virtual List<Nutzeinheit> Nutzeinheiten { get; set; }

        [DataMember]
        public virtual List<BillingInformation> BillingInformations { get; set; }
    }

}

C# GetObjekt 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/objekte/{Guid} HTTP/1.1 
Host: messdienstservice-stadtwerke-peine-servdesk.eras-online.de 
Accept: application/json

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