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 .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}/HkEvaluate HTTP/1.1 
Host: andreiuologmbh-servamw.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EvaluateHkRadiators xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App">00000000-0000-0000-0000-000000000000</UserId>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <DeviceTypeIdentifier>String</DeviceTypeIdentifier>
  <MaxResultSize>0</MaxResultSize>
  <MountingPoint>String</MountingPoint>
  <Parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <RadiatorGroupId>0</RadiatorGroupId>
</EvaluateHkRadiators>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EvaluateHkRadiatorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <Radiators xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" 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>
</EvaluateHkRadiatorsResponse>