Server

<back to all web services

GetHkEvaluations

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkEvaluations
import Foundation
import ServiceStack

// @DataContract
public class GetHkEvaluations : Eras2AppServiceModelBase
{
    // @DataMember(Name="DeviceGuids")
    public var DeviceGuids:IList<String>

    // @DataMember(Name="ReceivedSince")
    public var ReceivedSince:Date?

    // @DataMember(Name="LatestPerDeviceOnly")
    public var LatestPerDeviceOnly:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case DeviceGuids
        case ReceivedSince
        case LatestPerDeviceOnly
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        DeviceGuids = try container.decodeIfPresent(IList<String>.self, forKey: .DeviceGuids)
        ReceivedSince = try container.decodeIfPresent(Date.self, forKey: .ReceivedSince)
        LatestPerDeviceOnly = try container.decodeIfPresent(Bool.self, forKey: .LatestPerDeviceOnly)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if DeviceGuids != nil { try container.encode(DeviceGuids, forKey: .DeviceGuids) }
        if ReceivedSince != nil { try container.encode(ReceivedSince, forKey: .ReceivedSince) }
        if LatestPerDeviceOnly != nil { try container.encode(LatestPerDeviceOnly, forKey: .LatestPerDeviceOnly) }
    }
}

// @DataContract
public class Eras2AppServiceModelBase : Codable
{
    // @DataMember(Name="UserId")
    public var UserId:String

    required public init(){}
}

// @DataContract
public class GetHkEvaluationsResponse : Codable
{
    // @DataMember(Name="Evaluations")
    public var Evaluations:IList<HkEvaluation>

    // @DataMember(Name="ResponseStatus")
    public var ResponseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class HkEvaluation : Codable
{
    // @DataMember(Name="Guid")
    public var Guid:String

    // @DataMember(Name="DeviceGuid")
    public var DeviceGuid:String

    // @DataMember(Name="DeviceNumber")
    public var DeviceNumber:String

    // @DataMember(Name="NutzeinheitNumber")
    public var NutzeinheitNumber:String

    // @DataMember(Name="NutzeinheitAddress")
    public var NutzeinheitAddress:String

    // @DataMember(Name="HkveModel")
    public var HkveModel:String

    // @DataMember(Name="HkveModelCustom")
    public var HkveModelCustom:String

    // @DataMember(Name="MountingPoint")
    public var MountingPoint:String

    // @DataMember(Name="MountingPointCustom")
    public var MountingPointCustom:String

    // @DataMember(Name="GroupId")
    public var GroupId:Int

    // @DataMember(Name="GroupName")
    public var GroupName:String

    // @DataMember(Name="TopMatch")
    public var TopMatch:String

    // @DataMember(Name="RadiatisRadiatorId")
    public var RadiatisRadiatorId:Int?

    // @DataMember(Name="ModelNoteReference")
    public var ModelNoteReference:String

    // @DataMember(Name="Match")
    public var Match:Int

    // @DataMember(Name="KcValue")
    public var KcValue:Double?

    // @DataMember(Name="KqValue")
    public var KqValue:Double?

    // @DataMember(Name="Created")
    public var Created:Date

    // @DataMember(Name="LastModified")
    public var LastModified:Date?

    // @DataMember(Name="TechnicianUserId")
    public var TechnicianUserId:String

    // @DataMember(Name="ReceivedAt")
    public var ReceivedAt:Date?

    // @DataMember(Name="Parameters")
    public var Parameters:IList<HkEvaluationParameter>

    // @DataMember(Name="Attributes")
    public var Attributes:IList<HkEvaluationAttribute>

    required public init(){}
}

// @DataContract
public class HkEvaluationParameter : Codable
{
    // @DataMember(Name="RadiatisId")
    public var RadiatisId:Int

    // @DataMember(Name="Code")
    public var Code:String

    // @DataMember(Name="Value")
    public var Value:String

    required public init(){}
}

// @DataContract
public class HkEvaluationAttribute : Codable
{
    // @DataMember(Name="RadiatisId")
    public var RadiatisId:Int

    // @DataMember(Name="Code")
    public var Code:String

    // @DataMember(Name="Value")
    public var Value:Int

    required public init(){}
}


Swift GetHkEvaluations DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: marneth-messdienst-servamw.eras-online.de 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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