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 .jsv suffix or ?format=jsv

HTTP + JSV

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: imm-con-gmbh-servamw.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RadiatorGroupId: 0,
	DeviceTypeIdentifier: String,
	MountingPoint: String,
	MaxResultSize: 0,
	UserId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}