Server

<back to all web services

AddHkEvaluations

Requires Authentication
The following routes are available for this service:
POST/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 AddHkEvaluationsResponse:
    accepted_guids: Optional[IList[str]] = None
    response_status: Optional[ResponseStatus] = 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 AddHkEvaluations(Eras2AppServiceModelBase):
    evaluations: Optional[IList[HkEvaluation]] = None

Python AddHkEvaluations DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /App/{UserId}/HkEvaluations HTTP/1.1 
Host: heat-syke-servamw.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddHkEvaluations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Add">
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App">00000000-0000-0000-0000-000000000000</UserId>
  <Evaluations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
</AddHkEvaluations>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddHkEvaluationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Add">
  <AcceptedGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AddHkEvaluationsResponse>