Server

<back to all web services

GetNebenkostenList

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten
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.Enums;

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums
{
    public enum NebenkostenTargetAllocation
    {
        Null,
        AlleNutzer,
        ZugeordneteNutzer,
        ZugeordneteNutzeinheiten,
        ZugeordneteNutzerDiff,
        ZugeordneteNutzeinheitenDiff,
    }

    public enum NebenkostenTargetAllocationIn
    {
        Nebenkosten,
        Heizkosten,
        Warmwasserkosten,
    }

}

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

        ///<summary>
        ///Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*
        ///</summary>
        [DataMember(Name="filter[ObjektGuid]")]
        [ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*", ParameterType="query")]
        public virtual string FilterByObjektGuid { get; set; }

        ///<summary>
        ///Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*
        ///</summary>
        [DataMember(Name="filter[BillingInformationGuid]")]
        [ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*", ParameterType="query")]
        public virtual string FilterByBillingInformationGuid { get; set; }
    }

    public partial class GetNebenkostenListResponse
    {
        public virtual IEnumerable<Nebenkosten> NebenkostenList { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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

        [DataMember]
        public virtual DateTime From { get; set; }

        [DataMember]
        public virtual DateTime To { get; set; }

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

        [DataMember]
        public virtual bool HasNebenkosten { get; set; }
    }

    [DataContract]
    public partial class Nebenkosten
    {
        public Nebenkosten()
        {
            NebenkostenNutzeinheiten = new List<NebenkostenNutzeinheit>{};
            NebenkostenNutzer = new List<NebenkostenNutzer>{};
        }

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

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

        [DataMember]
        public virtual DateTime From { get; set; }

        [DataMember]
        public virtual DateTime To { get; set; }

        [DataMember]
        public virtual NebenkostenTargetAllocation? TargetAllocation { get; set; }

        [DataMember]
        public virtual NebenkostenTargetAllocationIn? TargetAllocationIn { get; set; }

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

        ///<summary>
        ///Freitext
        ///</summary>
        [DataMember]
        [ApiMember(Description="Freitext")]
        public virtual string Kostenart { get; set; }

        [DataMember]
        public virtual decimal? Brutto { get; set; }

        [DataMember]
        public virtual decimal? BruttoLastYear { get; set; }

        [DataMember]
        public virtual decimal? SalesTax { get; set; }

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

        [DataMember]
        public virtual decimal? HaushaltsnahediensteBrutto { get; set; }

        ///<summary>
        ///Freitext
        ///</summary>
        [DataMember]
        [ApiMember(Description="Freitext")]
        public virtual string KostenartUnit { get; set; }

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

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

        [DataMember]
        public virtual bool IsDeleted { get; set; }

        [DataMember]
        public virtual bool IsCreatedByApp { get; set; }

        [DataMember]
        public virtual List<NebenkostenNutzeinheit> NebenkostenNutzeinheiten { get; set; }

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

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

    [DataContract]
    public partial class NebenkostenNutzeinheit
    {
        [DataMember]
        public virtual decimal? RelativeAmount { get; set; }

        [DataMember]
        public virtual bool IsDeleted { get; set; }

        [DataMember]
        public virtual bool IsCreatedByApp { get; set; }

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

    [DataContract]
    public partial class NebenkostenNutzer
    {
        [DataMember]
        public virtual decimal? RelativeAmount { get; set; }

        [DataMember]
        public virtual bool IsDeleted { get; set; }

        [DataMember]
        public virtual bool IsCreatedByApp { get; set; }

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

}

C# GetNebenkostenList DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/nebenkosten HTTP/1.1 
Host: brendle-schneider-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNebenkostenListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <NebenkostenList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetNebenkostenListResponse>