Server

<back to all web services

GetHkEvaluations

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkEvaluations
GetHkEvaluations Parameters:
NameParameterData TypeRequiredDescription
DeviceGuidsqueryIList<Guid>No
ReceivedSincequeryDateTime?No
LatestPerDeviceOnlyqueryboolNo
GetHkEvaluationsResponse Parameters:
NameParameterData TypeRequiredDescription
EvaluationsformIList<HkEvaluation>No
ResponseStatusformResponseStatusNo
HkEvaluation Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
DeviceGuidformGuidNo
DeviceNumberformstringNo
NutzeinheitNumberformstringNo
NutzeinheitAddressformstringNo
HkveModelformstringNo
HkveModelCustomformstringNo
MountingPointformstringNo
MountingPointCustomformstringNo
GroupIdformintNo
GroupNameformstringNo
TopMatchformstringNo
RadiatisRadiatorIdformint?No
ModelNoteReferenceformstringNo
MatchformintNo
KcValueformdecimal?No
KqValueformdecimal?No
CreatedformDateTimeNo
LastModifiedformDateTime?No
TechnicianUserIdformstringNo
ReceivedAtformDateTime?No
ParametersformIList<HkEvaluationParameter>No
AttributesformIList<HkEvaluationAttribute>No
HkEvaluationParameter Parameters:
NameParameterData TypeRequiredDescription
RadiatisIdformintNo
CodeformstringNo
ValueformstringNo
HkEvaluationAttribute Parameters:
NameParameterData TypeRequiredDescription
RadiatisIdformintNo
CodeformstringNo
ValueformintNo

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.

GET /App/{UserId}/HkEvaluations HTTP/1.1 
Host: develop-servamw.eras-online.de 
Accept: text/jsv
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
		}
	}
}