Server

<back to all web services

GetHkEvaluations

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkEvaluations
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 HkEvaluationParameter:
    radiatis_id: int = 0
    code: Optional[str] = None
    value: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkEvaluation:
    guid: Optional[str] = None
    device_guid: Optional[str] = None
    device_number: Optional[str] = None
    nutzeinheit_number: Optional[str] = None
    nutzeinheit_address: Optional[str] = None
    hkve_model: Optional[str] = None
    hkve_model_custom: Optional[str] = None
    mounting_point: Optional[str] = None
    mounting_point_custom: Optional[str] = None
    group_id: int = 0
    group_name: Optional[str] = None
    top_match: Optional[str] = None
    radiatis_radiator_id: Optional[int] = None
    model_note_reference: Optional[str] = None
    match: int = 0
    kc_value: Optional[Decimal] = None
    kq_value: Optional[Decimal] = None
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    last_modified: Optional[datetime.datetime] = None
    technician_user_id: Optional[str] = None
    received_at: Optional[datetime.datetime] = None
    parameters: Optional[IList[HkEvaluationParameter]] = None
    attributes: Optional[IList[HkEvaluationAttribute]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetHkEvaluationsResponse:
    evaluations: Optional[IList[HkEvaluation]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetHkEvaluations(Eras2AppServiceModelBase):
    device_guids: Optional[IList[str]] = None
    received_since: Optional[datetime.datetime] = None
    latest_per_device_only: bool = False

Python GetHkEvaluations DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: brendle-schneider-servamw.eras-online.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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