Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
EvaluateHkRadiators Parameters:
NameParameterData TypeRequiredDescription
RadiatorGroupIdbodyintNo
ParametersbodyIList<HkEvaluateParameter>No
AttributesbodyIList<HkEvaluateAttribute>No
DeviceTypeIdentifierbodystringNo
MountingPointbodystringNo
MaxResultSizebodyintNo
Eras2AppServiceModelBase Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
HkEvaluateParameter Parameters:
NameParameterData TypeRequiredDescription
RadiatisIdformintNo
ValueformstringNo
HkEvaluateAttribute Parameters:
NameParameterData TypeRequiredDescription
RadiatisIdformintNo
ValueformintNo
EvaluateHkRadiatorsResponse Parameters:
NameParameterData TypeRequiredDescription
RadiatorsformIList<HkRadiatorMatch>No
ResponseStatusformResponseStatusNo
HkRadiatorMatch Parameters:
NameParameterData TypeRequiredDescription
MatchformintNo
RadiatisRadiatorIdformint?No
ProducerformstringNo
ModelformstringNo
ModelNoteReferenceformstringNo
KcValueformdecimal?No
KqValueformdecimal?No
KtValueformdecimal?No
DifferencesformIList<HkMatchDifference>No
HkMatchDifference Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ValueformstringNo

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

{
	RadiatorGroupId: 0,
	DeviceTypeIdentifier: String,
	MountingPoint: String,
	MaxResultSize: 0,
	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
		}
	}
}