Server

<back to all web services

GetNebenkosten

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten/{Guid}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Enums

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

        Public Enum NebenkostenTargetAllocation
            Null
            AlleNutzer
            ZugeordneteNutzer
            ZugeordneteNutzeinheiten
            ZugeordneteNutzerDiff
            ZugeordneteNutzeinheitenDiff
        End Enum

        Public Enum NebenkostenTargetAllocationIn
            Nebenkosten
            Heizkosten
            Warmwasserkosten
        End Enum
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetNebenkosten
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            <ApiMember(IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Guid As Guid
        End Class

        Public Partial Class GetNebenkostenResponse
            Public Overridable Property Nebenkosten As Nebenkosten
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models

        <DataContract>
        Public Partial Class BillingInformation
            <DataMember>
            Public Overridable Property Guid As String

            <DataMember>
            Public Overridable Property From As Date

            <DataMember>
            Public Overridable Property To As Date

            <DataMember>
            Public Overridable Property IsCompleted As Boolean

            <DataMember>
            Public Overridable Property HasNebenkosten As Boolean
        End Class

        <DataContract>
        Public Partial Class Nebenkosten
            Public Sub New()
                NebenkostenNutzeinheiten = New List(Of NebenkostenNutzeinheit)
                NebenkostenNutzer = New List(Of NebenkostenNutzer)
            End Sub

            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property Number As UInt32

            <DataMember>
            Public Overridable Property From As Date

            <DataMember>
            Public Overridable Property To As Date

            <DataMember>
            Public Overridable Property TargetAllocation As Nullable(Of NebenkostenTargetAllocation)

            <DataMember>
            Public Overridable Property TargetAllocationIn As Nullable(Of NebenkostenTargetAllocationIn)

            <DataMember>
            Public Overridable Property NebenkostenKind As String

            '''<Summary>
            '''Freitext
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Freitext")>
            Public Overridable Property Kostenart As String

            <DataMember>
            Public Overridable Property Brutto As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property BruttoLastYear As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property SalesTax As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property HaushaltsnahediensteLabel As String

            <DataMember>
            Public Overridable Property HaushaltsnahediensteBrutto As Nullable(Of Decimal)

            '''<Summary>
            '''Freitext
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Freitext")>
            Public Overridable Property KostenartUnit As String

            <DataMember>
            Public Overridable Property ReduzierungsartType As String

            <DataMember>
            Public Overridable Property Comment As String

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

            <DataMember>
            Public Overridable Property NebenkostenNutzeinheiten As List(Of NebenkostenNutzeinheit)

            <DataMember>
            Public Overridable Property NebenkostenNutzer As List(Of NebenkostenNutzer)

            <DataMember>
            Public Overridable Property BillingInformation As BillingInformation
        End Class

        <DataContract>
        Public Partial Class NebenkostenNutzeinheit
            <DataMember>
            Public Overridable Property RelativeAmount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

            <DataMember>
            Public Overridable Property NutzeinheitGuid As Guid
        End Class

        <DataContract>
        Public Partial Class NebenkostenNutzer
            <DataMember>
            Public Overridable Property RelativeAmount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

            <DataMember>
            Public Overridable Property NutzerGuid As Guid
        End Class
    End Namespace
End Namespace

VB.NET GetNebenkosten 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/{Guid} HTTP/1.1 
Host: develop-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNebenkostenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Nebenkosten xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:BillingInformation>
      <d2p1:From>0001-01-01T00:00:00</d2p1:From>
      <d2p1:Guid>String</d2p1:Guid>
      <d2p1:HasNebenkosten>false</d2p1:HasNebenkosten>
      <d2p1:IsCompleted>false</d2p1:IsCompleted>
      <d2p1:To>0001-01-01T00:00:00</d2p1:To>
    </d2p1:BillingInformation>
    <d2p1:Brutto>0</d2p1:Brutto>
    <d2p1:BruttoLastYear>0</d2p1:BruttoLastYear>
    <d2p1:Comment>String</d2p1:Comment>
    <d2p1:From>0001-01-01T00:00:00</d2p1:From>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:HaushaltsnahediensteBrutto>0</d2p1:HaushaltsnahediensteBrutto>
    <d2p1:HaushaltsnahediensteLabel>String</d2p1:HaushaltsnahediensteLabel>
    <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:Kostenart>String</d2p1:Kostenart>
    <d2p1:KostenartUnit>String</d2p1:KostenartUnit>
    <d2p1:NebenkostenKind>String</d2p1:NebenkostenKind>
    <d2p1:NebenkostenNutzeinheiten>
      <d2p1:NebenkostenNutzeinheit>
        <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:NutzeinheitGuid>00000000-0000-0000-0000-000000000000</d2p1:NutzeinheitGuid>
        <d2p1:RelativeAmount>0</d2p1:RelativeAmount>
      </d2p1:NebenkostenNutzeinheit>
    </d2p1:NebenkostenNutzeinheiten>
    <d2p1:NebenkostenNutzer>
      <d2p1:NebenkostenNutzer>
        <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:NutzerGuid>00000000-0000-0000-0000-000000000000</d2p1:NutzerGuid>
        <d2p1:RelativeAmount>0</d2p1:RelativeAmount>
      </d2p1:NebenkostenNutzer>
    </d2p1:NebenkostenNutzer>
    <d2p1:Number>0</d2p1:Number>
    <d2p1:ReduzierungsartType>String</d2p1:ReduzierungsartType>
    <d2p1:SalesTax>0</d2p1:SalesTax>
    <d2p1:TargetAllocation>Null</d2p1:TargetAllocation>
    <d2p1:TargetAllocationIn>Nebenkosten</d2p1:TargetAllocationIn>
    <d2p1:To>0001-01-01T00:00:00</d2p1:To>
  </Nebenkosten>
  <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>
</GetNebenkostenResponse>