Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Eras2AppServiceModelBase:
    user_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkMatchDifference:
    code: Optional[str] = None
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkRadiatorMatch:
    match: int = 0
    radiatis_radiator_id: Optional[int] = None
    producer: Optional[str] = None
    model: Optional[str] = None
    model_note_reference: Optional[str] = None
    kc_value: Optional[Decimal] = None
    kq_value: Optional[Decimal] = None
    kt_value: Optional[Decimal] = None
    differences: Optional[IList[HkMatchDifference]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EvaluateHkRadiatorsResponse:
    radiators: Optional[IList[HkRadiatorMatch]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkEvaluateParameter:
    radiatis_id: int = 0
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkEvaluateAttribute:
    radiatis_id: int = 0
    value: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EvaluateHkRadiators(Eras2AppServiceModelBase):
    radiator_group_id: int = 0
    parameters: Optional[IList[HkEvaluateParameter]] = None
    attributes: Optional[IList[HkEvaluateAttribute]] = None
    device_type_identifier: Optional[str] = None
    mounting_point: Optional[str] = None
    max_result_size: int = 0

Python 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: marneth-messdienst-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
		}
	}
}