Server

<back to all web services

PutNebenkosten

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

public class PutNebenkosten : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="body")
    public var nebenkosten:Nebenkosten

    // @ApiMember(IsRequired=true, ParameterType="body")
    public var relatedToObjekt:RelatedTo

    // @ApiMember(IsRequired=true, ParameterType="body")
    public var relatedToBillingInformation:RelatedTo

    // @ApiMember(IsRequired=true, ParameterType="body")
    public var bearerToken:String

    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(){}
}

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

    required public init(){}
}

public class PutNebenkostenResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift PutNebenkosten 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.

PUT /api/v1/nebenkosten HTTP/1.1 
Host: mitchell-servdesk.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutNebenkosten xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Put">
  <BearerToken>String</BearerToken>
  <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>
  <RelatedToBillingInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToBillingInformation>
  <RelatedToObjekt xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToObjekt>
</PutNebenkosten>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutNebenkostenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Put">
  <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>
</PutNebenkostenResponse>