Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
"use strict";
export class Eras2AppServiceModelBase {
    /** @param {{UserId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
}
export class HkMatchDifference {
    /** @param {{Code?:string,Name?:string,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Value;
}
export class HkRadiatorMatch {
    /** @param {{Match?:number,RadiatisRadiatorId?:number,Producer?:string,Model?:string,ModelNoteReference?:string,KcValue?:number,KqValue?:number,KtValue?:number,Differences?:IList<HkMatchDifference>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Match;
    /** @type {?number} */
    RadiatisRadiatorId;
    /** @type {string} */
    Producer;
    /** @type {string} */
    Model;
    /** @type {string} */
    ModelNoteReference;
    /** @type {?number} */
    KcValue;
    /** @type {?number} */
    KqValue;
    /** @type {?number} */
    KtValue;
    /** @type {IList<HkMatchDifference>} */
    Differences;
}
export class EvaluateHkRadiatorsResponse {
    /** @param {{Radiators?:IList<HkRadiatorMatch>,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IList<HkRadiatorMatch>} */
    Radiators;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class HkEvaluateParameter {
    /** @param {{RadiatisId?:number,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RadiatisId;
    /** @type {string} */
    Value;
}
export class HkEvaluateAttribute {
    /** @param {{RadiatisId?:number,Value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RadiatisId;
    /** @type {number} */
    Value;
}
export class EvaluateHkRadiators extends Eras2AppServiceModelBase {
    /** @param {{RadiatorGroupId?:number,Parameters?:IList<HkEvaluateParameter>,Attributes?:IList<HkEvaluateAttribute>,DeviceTypeIdentifier?:string,MountingPoint?:string,MaxResultSize?:number,UserId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    RadiatorGroupId;
    /** @type {IList<HkEvaluateParameter>} */
    Parameters;
    /** @type {IList<HkEvaluateAttribute>} */
    Attributes;
    /** @type {string} */
    DeviceTypeIdentifier;
    /** @type {string} */
    MountingPoint;
    /** @type {number} */
    MaxResultSize;
}

JavaScript EvaluateHkRadiators DTOs

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

HTTP + 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: stage-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"}}}