Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate

// @DataContract
export class Eras2AppServiceModelBase
{
    // @DataMember(Name="UserId")
    public UserId: string;

    public constructor(init?: Partial<Eras2AppServiceModelBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkMatchDifference
{
    // @DataMember(Name="Code")
    public Code: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Value")
    public Value: string;

    public constructor(init?: Partial<HkMatchDifference>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkRadiatorMatch
{
    // @DataMember(Name="Match")
    public Match: number;

    // @DataMember(Name="RadiatisRadiatorId")
    public RadiatisRadiatorId?: number;

    // @DataMember(Name="Producer")
    public Producer: string;

    // @DataMember(Name="Model")
    public Model: string;

    // @DataMember(Name="ModelNoteReference")
    public ModelNoteReference: string;

    // @DataMember(Name="KcValue")
    public KcValue?: number;

    // @DataMember(Name="KqValue")
    public KqValue?: number;

    // @DataMember(Name="KtValue")
    public KtValue?: number;

    // @DataMember(Name="Differences")
    public Differences: IList<HkMatchDifference>;

    public constructor(init?: Partial<HkRadiatorMatch>) { (Object as any).assign(this, init); }
}

// @DataContract
export class EvaluateHkRadiatorsResponse
{
    // @DataMember(Name="Radiators")
    public Radiators: IList<HkRadiatorMatch>;

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

    public constructor(init?: Partial<EvaluateHkRadiatorsResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkEvaluateParameter
{
    // @DataMember(Name="RadiatisId")
    public RadiatisId: number;

    // @DataMember(Name="Value")
    public Value: string;

    public constructor(init?: Partial<HkEvaluateParameter>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkEvaluateAttribute
{
    // @DataMember(Name="RadiatisId")
    public RadiatisId: number;

    // @DataMember(Name="Value")
    public Value: number;

    public constructor(init?: Partial<HkEvaluateAttribute>) { (Object as any).assign(this, init); }
}

// @DataContract
export class EvaluateHkRadiators extends Eras2AppServiceModelBase
{
    // @DataMember(Name="RadiatorGroupId")
    public RadiatorGroupId: number;

    // @DataMember(Name="Parameters")
    public Parameters: IList<HkEvaluateParameter>;

    // @DataMember(Name="Attributes")
    public Attributes: IList<HkEvaluateAttribute>;

    // @DataMember(Name="DeviceTypeIdentifier")
    public DeviceTypeIdentifier: string;

    // @DataMember(Name="MountingPoint")
    public MountingPoint: string;

    // @DataMember(Name="MaxResultSize")
    public MaxResultSize: number;

    public constructor(init?: Partial<EvaluateHkRadiators>) { super(init); (Object as any).assign(this, init); }
}

TypeScript EvaluateHkRadiators DTOs

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

HTTP + CSV

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

{"RadiatorGroupId":0,"DeviceTypeIdentifier":"String","MountingPoint":"String","MaxResultSize":0,"UserId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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