Server

<back to all web services

AddHkEvaluations

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluations
"use strict";
export class Eras2AppServiceModelBase {
    /** @param {{UserId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
}
export class AddHkEvaluationsResponse {
    /** @param {{AcceptedGuids?:IList<string>,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IList<string>} */
    AcceptedGuids;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class HkEvaluationParameter {
    /** @param {{RadiatisId?:number,Code?:string,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RadiatisId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Value;
}
export class HkEvaluationAttribute {
    /** @param {{RadiatisId?:number,Code?:string,Value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RadiatisId;
    /** @type {string} */
    Code;
    /** @type {number} */
    Value;
}
export class HkEvaluation {
    /** @param {{Guid?:string,DeviceGuid?:string,DeviceNumber?:string,NutzeinheitNumber?:string,NutzeinheitAddress?:string,HkveModel?:string,HkveModelCustom?:string,MountingPoint?:string,MountingPointCustom?:string,GroupId?:number,GroupName?:string,TopMatch?:string,RadiatisRadiatorId?:number,ModelNoteReference?:string,Match?:number,KcValue?:number,KqValue?:number,Created?:string,LastModified?:string,TechnicianUserId?:string,ReceivedAt?:string,Parameters?:IList<HkEvaluationParameter>,Attributes?:IList<HkEvaluationAttribute>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    DeviceGuid;
    /** @type {string} */
    DeviceNumber;
    /** @type {string} */
    NutzeinheitNumber;
    /** @type {string} */
    NutzeinheitAddress;
    /** @type {string} */
    HkveModel;
    /** @type {string} */
    HkveModelCustom;
    /** @type {string} */
    MountingPoint;
    /** @type {string} */
    MountingPointCustom;
    /** @type {number} */
    GroupId;
    /** @type {string} */
    GroupName;
    /** @type {string} */
    TopMatch;
    /** @type {?number} */
    RadiatisRadiatorId;
    /** @type {string} */
    ModelNoteReference;
    /** @type {number} */
    Match;
    /** @type {?number} */
    KcValue;
    /** @type {?number} */
    KqValue;
    /** @type {string} */
    Created;
    /** @type {?string} */
    LastModified;
    /** @type {string} */
    TechnicianUserId;
    /** @type {?string} */
    ReceivedAt;
    /** @type {IList<HkEvaluationParameter>} */
    Parameters;
    /** @type {IList<HkEvaluationAttribute>} */
    Attributes;
}
export class AddHkEvaluations extends Eras2AppServiceModelBase {
    /** @param {{Evaluations?:IList<HkEvaluation>,UserId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IList<HkEvaluation>} */
    Evaluations;
}

JavaScript 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: kromer-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>