Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Amw.Service.Server.ServiceModel.Eras2App.Get
Imports Eras2Amw.Service.Server.ServiceModel.Eras2App
Imports Eras2Amw.Service.Server.ServiceModel.Common

Namespace Global

    Namespace Eras2Amw.Service.Server.ServiceModel.Common

        <DataContract>
        Public Partial Class HkEvaluateAttribute
            <DataMember(Name:="RadiatisId")>
            Public Overridable Property RadiatisId As Integer

            <DataMember(Name:="Value")>
            Public Overridable Property Value As Integer
        End Class

        <DataContract>
        Public Partial Class HkEvaluateParameter
            <DataMember(Name:="RadiatisId")>
            Public Overridable Property RadiatisId As Integer

            <DataMember(Name:="Value")>
            Public Overridable Property Value As String
        End Class

        <DataContract>
        Public Partial Class HkMatchDifference
            <DataMember(Name:="Code")>
            Public Overridable Property Code As String

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="Value")>
            Public Overridable Property Value As String
        End Class

        <DataContract>
        Public Partial Class HkRadiatorMatch
            <DataMember(Name:="Match")>
            Public Overridable Property Match As Integer

            <DataMember(Name:="RadiatisRadiatorId")>
            Public Overridable Property RadiatisRadiatorId As Nullable(Of Integer)

            <DataMember(Name:="Producer")>
            Public Overridable Property Producer As String

            <DataMember(Name:="Model")>
            Public Overridable Property Model As String

            <DataMember(Name:="ModelNoteReference")>
            Public Overridable Property ModelNoteReference As String

            <DataMember(Name:="KcValue")>
            Public Overridable Property KcValue As Nullable(Of Decimal)

            <DataMember(Name:="KqValue")>
            Public Overridable Property KqValue As Nullable(Of Decimal)

            <DataMember(Name:="KtValue")>
            Public Overridable Property KtValue As Nullable(Of Decimal)

            <DataMember(Name:="Differences")>
            Public Overridable Property Differences As IList(Of HkMatchDifference)
        End Class
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2App

        <DataContract>
        Public Partial Class Eras2AppServiceModelBase
            <DataMember(Name:="UserId")>
            Public Overridable Property UserId As Guid
        End Class
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2App.Get

        <DataContract>
        Public Partial Class EvaluateHkRadiators
            Inherits Eras2AppServiceModelBase
            <DataMember(Name:="RadiatorGroupId")>
            Public Overridable Property RadiatorGroupId As Integer

            <DataMember(Name:="Parameters")>
            Public Overridable Property Parameters As IList(Of HkEvaluateParameter)

            <DataMember(Name:="Attributes")>
            Public Overridable Property Attributes As IList(Of HkEvaluateAttribute)

            <DataMember(Name:="DeviceTypeIdentifier")>
            Public Overridable Property DeviceTypeIdentifier As String

            <DataMember(Name:="MountingPoint")>
            Public Overridable Property MountingPoint As String

            <DataMember(Name:="MaxResultSize")>
            Public Overridable Property MaxResultSize As Integer
        End Class

        <DataContract>
        Public Partial Class EvaluateHkRadiatorsResponse
            <DataMember(Name:="Radiators")>
            Public Overridable Property Radiators As IList(Of HkRadiatorMatch)

            <DataMember(Name:="ResponseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET EvaluateHkRadiators 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.

POST /App/{UserId}/HkEvaluate HTTP/1.1 
Host: mi-waerme-servamw.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EvaluateHkRadiators xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App">00000000-0000-0000-0000-000000000000</UserId>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <DeviceTypeIdentifier>String</DeviceTypeIdentifier>
  <MaxResultSize>0</MaxResultSize>
  <MountingPoint>String</MountingPoint>
  <Parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <RadiatorGroupId>0</RadiatorGroupId>
</EvaluateHkRadiators>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EvaluateHkRadiatorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <Radiators xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" 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>
</EvaluateHkRadiatorsResponse>