Server

<back to all web services

GetHkEvaluations

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkEvaluations
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 HkEvaluation
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

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

            <DataMember(Name:="ReceivedAt")>
            Public Overridable Property ReceivedAt As Nullable(Of Date)

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

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

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

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

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

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

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

            <DataMember(Name:="Value")>
            Public Overridable Property Value As String
        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 GetHkEvaluations
            Inherits Eras2AppServiceModelBase
            <DataMember(Name:="DeviceGuids")>
            Public Overridable Property DeviceGuids As IList(Of Guid)

            <DataMember(Name:="ReceivedSince")>
            Public Overridable Property ReceivedSince As Nullable(Of Date)

            <DataMember(Name:="LatestPerDeviceOnly")>
            Public Overridable Property LatestPerDeviceOnly As Boolean
        End Class

        <DataContract>
        Public Partial Class GetHkEvaluationsResponse
            <DataMember(Name:="Evaluations")>
            Public Overridable Property Evaluations As IList(Of HkEvaluation)

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

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

GET /App/{UserId}/HkEvaluations HTTP/1.1 
Host: messdienstservice-stadtwerke-peine-servamw.eras-online.de 
Accept: text/jsv
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
		}
	}
}