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

HTTP + XML

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: stage-servamw.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EvaluateHkRadiators xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <UserId xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App">00000000-0000-0000-0000-000000000000</UserId>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <DeviceTypeIdentifier>String</DeviceTypeIdentifier>
  <MaxResultSize>0</MaxResultSize>
  <MountingPoint>String</MountingPoint>
  <Parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <RadiatorGroupId>0</RadiatorGroupId>
</EvaluateHkRadiators>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EvaluateHkRadiatorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <Radiators xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</EvaluateHkRadiatorsResponse>