| POST | /App/{UserId}/HkEvaluate |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RadiatorGroupId | body | int | No | |
| Parameters | body | IList<HkEvaluateParameter> | No | |
| Attributes | body | IList<HkEvaluateAttribute> | No | |
| DeviceTypeIdentifier | body | string | No | |
| MountingPoint | body | string | No | |
| MaxResultSize | body | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RadiatisId | form | int | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RadiatisId | form | int | No | |
| Value | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Radiators | form | IList<HkRadiatorMatch> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Match | form | int | No | |
| RadiatisRadiatorId | form | int? | No | |
| Producer | form | string | No | |
| Model | form | string | No | |
| ModelNoteReference | form | string | No | |
| KcValue | form | decimal? | No | |
| KqValue | form | decimal? | No | |
| KtValue | form | decimal? | No | |
| Differences | form | IList<HkMatchDifference> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Name | form | string | No | |
| Value | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: fairtherm-servamw.eras-online.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"RadiatorGroupId":0,"DeviceTypeIdentifier":"String","MountingPoint":"String","MaxResultSize":0,"UserId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}