Server

<back to all web services

GetNebenkostenList

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten
namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type NebenkostenTargetAllocation =
        | Null = 0
        | AlleNutzer = 1
        | ZugeordneteNutzer = 2
        | ZugeordneteNutzeinheiten = 3
        | ZugeordneteNutzerDiff = 4
        | ZugeordneteNutzeinheitenDiff = 5

    type NebenkostenTargetAllocationIn =
        | Nebenkosten = 0
        | Heizkosten = 1
        | Warmwasserkosten = 2

    [<DataContract>]
    [<AllowNullLiteral>]
    type NebenkostenNutzeinheit() = 
        [<DataMember>]
        member val RelativeAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val IsDeleted:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsCreatedByApp:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val NutzeinheitGuid:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type NebenkostenNutzer() = 
        [<DataMember>]
        member val RelativeAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val IsDeleted:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsCreatedByApp:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val NutzerGuid:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BillingInformation() = 
        [<DataMember>]
        member val Guid:String = null with get,set

        [<DataMember>]
        member val From:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val To:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val IsCompleted:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val HasNebenkosten:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Nebenkosten() = 
        [<DataMember>]
        member val Guid:Guid = new Guid() with get,set

        [<DataMember>]
        member val Number:UInt32 = new UInt32() with get,set

        [<DataMember>]
        member val From:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val To:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val TargetAllocation:Nullable<NebenkostenTargetAllocation> = new Nullable<NebenkostenTargetAllocation>() with get,set

        [<DataMember>]
        member val TargetAllocationIn:Nullable<NebenkostenTargetAllocationIn> = new Nullable<NebenkostenTargetAllocationIn>() with get,set

        [<DataMember>]
        member val NebenkostenKind:String = null with get,set

        ///<summary>
        ///Freitext
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Freitext")>]
        member val Kostenart:String = null with get,set

        [<DataMember>]
        member val Brutto:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val BruttoLastYear:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val SalesTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val HaushaltsnahediensteLabel:String = null with get,set

        [<DataMember>]
        member val HaushaltsnahediensteBrutto:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        ///<summary>
        ///Freitext
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Freitext")>]
        member val KostenartUnit:String = null with get,set

        [<DataMember>]
        member val ReduzierungsartType:String = null with get,set

        [<DataMember>]
        member val Comment:String = null with get,set

        [<DataMember>]
        member val IsDeleted:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsCreatedByApp:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val NebenkostenNutzeinheiten:ResizeArray<NebenkostenNutzeinheit> = new ResizeArray<NebenkostenNutzeinheit>() with get,set

        [<DataMember>]
        member val NebenkostenNutzer:ResizeArray<NebenkostenNutzer> = new ResizeArray<NebenkostenNutzer>() with get,set

        [<DataMember>]
        member val BillingInformation:BillingInformation = null with get,set

    [<AllowNullLiteral>]
    type GetNebenkostenListResponse() = 
        member val NebenkostenList:IEnumerable<Nebenkosten> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetNebenkostenList() = 
        [<ApiMember(IsRequired=true, ParameterType="query")>]
        member val BearerToken:String = null with 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")>]
        member val FilterByObjektGuid:String = null with 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")>]
        member val FilterByBillingInformationGuid:String = null with get,set

F# 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>