| GET | /api/v1/nebenkosten |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BearerToken | query | string | Yes | |
| FilterByObjektGuid | query | string | No | Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=* |
| FilterByBillingInformationGuid | query | string | No | Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=* |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NebenkostenList | form | IEnumerable<Nebenkosten> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| Number | form | uint | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| TargetAllocation | form | NebenkostenTargetAllocation? | No | Allowable Values
|
| TargetAllocationIn | form | NebenkostenTargetAllocationIn? | No | Allowable Values
|
| NebenkostenKind | form | string | No | Allowable Values
|
| Kostenart | form | string | No | Freitext |
| Brutto | form | decimal? | No | |
| BruttoLastYear | form | decimal? | No | |
| SalesTax | form | decimal? | No | |
| HaushaltsnahediensteLabel | form | string | No | |
| HaushaltsnahediensteBrutto | form | decimal? | No | |
| KostenartUnit | form | string | No | Freitext |
| ReduzierungsartType | form | string | No | Allowable Values
|
| Comment | form | string | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NebenkostenNutzeinheiten | form | List<NebenkostenNutzeinheit> | No | |
| NebenkostenNutzer | form | List<NebenkostenNutzer> | No | |
| BillingInformation | form | BillingInformation | No |
| Null | |
| AlleNutzer | |
| ZugeordneteNutzer | |
| ZugeordneteNutzeinheiten | |
| ZugeordneteNutzerDiff | |
| ZugeordneteNutzeinheitenDiff |
| Nebenkosten | |
| Heizkosten | |
| Warmwasserkosten |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RelativeAmount | form | decimal? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NutzeinheitGuid | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RelativeAmount | form | decimal? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NutzerGuid | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| IsCompleted | form | bool | No | |
| HasNebenkosten | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: messtechnik-horb-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>