Server

<back to all web services

GetNebenkostenList

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten
import Foundation
import ServiceStack

public class GetNebenkostenList : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public var bearerToken:String

    /**
    * Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*
    */
    // @DataMember(Name="filter[ObjektGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*", ParameterType="query")
    public var filter_ObjektGuid_:String

    /**
    * Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*
    */
    // @DataMember(Name="filter[BillingInformationGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*", ParameterType="query")
    public var filter_BillingInformationGuid_:String

    required public init(){}
}

public class GetNebenkostenListResponse : Codable
{
    public var nebenkostenList:[Nebenkosten] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class Nebenkosten : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var number:UInt32

    // @DataMember
    public var from:Date

    // @DataMember
    public var to:Date

    // @DataMember
    public var targetAllocation:NebenkostenTargetAllocation?

    // @DataMember
    public var targetAllocationIn:NebenkostenTargetAllocationIn?

    // @DataMember
    public var nebenkostenKind:String

    /**
    * Freitext
    */
    // @DataMember
    // @ApiMember(Description="Freitext")
    public var kostenart:String

    // @DataMember
    public var brutto:Double?

    // @DataMember
    public var bruttoLastYear:Double?

    // @DataMember
    public var salesTax:Double?

    // @DataMember
    public var haushaltsnahediensteLabel:String

    // @DataMember
    public var haushaltsnahediensteBrutto:Double?

    /**
    * Freitext
    */
    // @DataMember
    // @ApiMember(Description="Freitext")
    public var kostenartUnit:String

    // @DataMember
    public var reduzierungsartType:String

    // @DataMember
    public var comment:String

    // @DataMember
    public var isDeleted:Bool

    // @DataMember
    public var isCreatedByApp:Bool

    // @DataMember
    public var nebenkostenNutzeinheiten:[NebenkostenNutzeinheit] = []

    // @DataMember
    public var nebenkostenNutzer:[NebenkostenNutzer] = []

    // @DataMember
    public var billingInformation:BillingInformation

    required public init(){}
}

public enum NebenkostenTargetAllocation : String, Codable
{
    case Null
    case AlleNutzer
    case ZugeordneteNutzer
    case ZugeordneteNutzeinheiten
    case ZugeordneteNutzerDiff
    case ZugeordneteNutzeinheitenDiff
}

public enum NebenkostenTargetAllocationIn : String, Codable
{
    case Nebenkosten
    case Heizkosten
    case Warmwasserkosten
}

// @DataContract
public class NebenkostenNutzeinheit : Codable
{
    // @DataMember
    public var relativeAmount:Double?

    // @DataMember
    public var isDeleted:Bool

    // @DataMember
    public var isCreatedByApp:Bool

    // @DataMember
    public var nutzeinheitGuid:String

    required public init(){}
}

// @DataContract
public class NebenkostenNutzer : Codable
{
    // @DataMember
    public var relativeAmount:Double?

    // @DataMember
    public var isDeleted:Bool

    // @DataMember
    public var isCreatedByApp:Bool

    // @DataMember
    public var nutzerGuid:String

    required public init(){}
}

// @DataContract
public class BillingInformation : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var from:Date

    // @DataMember
    public var to:Date

    // @DataMember
    public var isCompleted:Bool

    // @DataMember
    public var hasNebenkosten:Bool

    required public init(){}
}

Swift 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: develop-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>