Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class EvaluateHkRadiators : Eras2AppServiceModelBase()
{
    @DataMember(Name="RadiatorGroupId")
    @SerializedName("RadiatorGroupId")
    var radiatorGroupId:Int? = null

    @DataMember(Name="Parameters")
    @SerializedName("Parameters")
    var parameters:IList<HkEvaluateParameter>? = null

    @DataMember(Name="Attributes")
    @SerializedName("Attributes")
    var attributes:IList<HkEvaluateAttribute>? = null

    @DataMember(Name="DeviceTypeIdentifier")
    @SerializedName("DeviceTypeIdentifier")
    var deviceTypeIdentifier:String? = null

    @DataMember(Name="MountingPoint")
    @SerializedName("MountingPoint")
    var mountingPoint:String? = null

    @DataMember(Name="MaxResultSize")
    @SerializedName("MaxResultSize")
    var maxResultSize:Int? = null
}

@DataContract
open class Eras2AppServiceModelBase
{
    @DataMember(Name="UserId")
    @SerializedName("UserId")
    var userId:UUID? = null
}

@DataContract
open class HkEvaluateParameter
{
    @DataMember(Name="RadiatisId")
    @SerializedName("RadiatisId")
    var radiatisId:Int? = null

    @DataMember(Name="Value")
    @SerializedName("Value")
    var value:String? = null
}

@DataContract
open class HkEvaluateAttribute
{
    @DataMember(Name="RadiatisId")
    @SerializedName("RadiatisId")
    var radiatisId:Int? = null

    @DataMember(Name="Value")
    @SerializedName("Value")
    var value:Int? = null
}

@DataContract
open class EvaluateHkRadiatorsResponse
{
    @DataMember(Name="Radiators")
    @SerializedName("Radiators")
    var radiators:IList<HkRadiatorMatch>? = null

    @DataMember(Name="ResponseStatus")
    @SerializedName("ResponseStatus")
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class HkRadiatorMatch
{
    @DataMember(Name="Match")
    @SerializedName("Match")
    var match:Int? = null

    @DataMember(Name="RadiatisRadiatorId")
    @SerializedName("RadiatisRadiatorId")
    var radiatisRadiatorId:Int? = null

    @DataMember(Name="Producer")
    @SerializedName("Producer")
    var producer:String? = null

    @DataMember(Name="Model")
    @SerializedName("Model")
    var model:String? = null

    @DataMember(Name="ModelNoteReference")
    @SerializedName("ModelNoteReference")
    var modelNoteReference:String? = null

    @DataMember(Name="KcValue")
    @SerializedName("KcValue")
    var kcValue:BigDecimal? = null

    @DataMember(Name="KqValue")
    @SerializedName("KqValue")
    var kqValue:BigDecimal? = null

    @DataMember(Name="KtValue")
    @SerializedName("KtValue")
    var ktValue:BigDecimal? = null

    @DataMember(Name="Differences")
    @SerializedName("Differences")
    var differences:IList<HkMatchDifference>? = null
}

@DataContract
open class HkMatchDifference
{
    @DataMember(Name="Code")
    @SerializedName("Code")
    var code:String? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="Value")
    @SerializedName("Value")
    var value:String? = null
}

Kotlin 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
		}
	}
}