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 .jsv suffix or ?format=jsv

HTTP + JSV

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: faabrechnungen-servamw.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}