Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class Eras2AppServiceModelBase
{
    // @DataMember(Name="UserId")
    String? UserId;

    Eras2AppServiceModelBase({this.UserId});
    Eras2AppServiceModelBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserId = json['userId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': UserId
    };

    getTypeName() => "Eras2AppServiceModelBase";
    TypeContext? context = _ctx;
}

// @DataContract
class HkMatchDifference implements IConvertible
{
    // @DataMember(Name="Code")
    String? Code;

    // @DataMember(Name="Name")
    String? Name;

    // @DataMember(Name="Value")
    String? Value;

    HkMatchDifference({this.Code,this.Name,this.Value});
    HkMatchDifference.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['code'];
        Name = json['name'];
        Value = json['value'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'code': Code,
        'name': Name,
        'value': Value
    };

    getTypeName() => "HkMatchDifference";
    TypeContext? context = _ctx;
}

// @DataContract
class HkRadiatorMatch implements IConvertible
{
    // @DataMember(Name="Match")
    int? Match;

    // @DataMember(Name="RadiatisRadiatorId")
    int? RadiatisRadiatorId;

    // @DataMember(Name="Producer")
    String? Producer;

    // @DataMember(Name="Model")
    String? Model;

    // @DataMember(Name="ModelNoteReference")
    String? ModelNoteReference;

    // @DataMember(Name="KcValue")
    double? KcValue;

    // @DataMember(Name="KqValue")
    double? KqValue;

    // @DataMember(Name="KtValue")
    double? KtValue;

    // @DataMember(Name="Differences")
    List<HkMatchDifference>? Differences;

    HkRadiatorMatch({this.Match,this.RadiatisRadiatorId,this.Producer,this.Model,this.ModelNoteReference,this.KcValue,this.KqValue,this.KtValue,this.Differences});
    HkRadiatorMatch.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Match = json['match'];
        RadiatisRadiatorId = json['radiatisRadiatorId'];
        Producer = json['producer'];
        Model = json['model'];
        ModelNoteReference = json['modelNoteReference'];
        KcValue = JsonConverters.toDouble(json['kcValue']);
        KqValue = JsonConverters.toDouble(json['kqValue']);
        KtValue = JsonConverters.toDouble(json['ktValue']);
        Differences = JsonConverters.fromJson(json['differences'],'List<HkMatchDifference>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'match': Match,
        'radiatisRadiatorId': RadiatisRadiatorId,
        'producer': Producer,
        'model': Model,
        'modelNoteReference': ModelNoteReference,
        'kcValue': KcValue,
        'kqValue': KqValue,
        'ktValue': KtValue,
        'differences': JsonConverters.toJson(Differences,'List<HkMatchDifference>',context!)
    };

    getTypeName() => "HkRadiatorMatch";
    TypeContext? context = _ctx;
}

// @DataContract
class EvaluateHkRadiatorsResponse implements IConvertible
{
    // @DataMember(Name="Radiators")
    List<HkRadiatorMatch>? Radiators;

    // @DataMember(Name="ResponseStatus")
    ResponseStatus? ResponseStatus;

    EvaluateHkRadiatorsResponse({this.Radiators,this.ResponseStatus});
    EvaluateHkRadiatorsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Radiators = JsonConverters.fromJson(json['radiators'],'List<HkRadiatorMatch>',context!);
        ResponseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'radiators': JsonConverters.toJson(Radiators,'List<HkRadiatorMatch>',context!),
        'responseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "EvaluateHkRadiatorsResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class HkEvaluateParameter implements IConvertible
{
    // @DataMember(Name="RadiatisId")
    int? RadiatisId;

    // @DataMember(Name="Value")
    String? Value;

    HkEvaluateParameter({this.RadiatisId,this.Value});
    HkEvaluateParameter.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RadiatisId = json['radiatisId'];
        Value = json['value'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'radiatisId': RadiatisId,
        'value': Value
    };

    getTypeName() => "HkEvaluateParameter";
    TypeContext? context = _ctx;
}

// @DataContract
class HkEvaluateAttribute implements IConvertible
{
    // @DataMember(Name="RadiatisId")
    int? RadiatisId;

    // @DataMember(Name="Value")
    int? Value;

    HkEvaluateAttribute({this.RadiatisId,this.Value});
    HkEvaluateAttribute.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RadiatisId = json['radiatisId'];
        Value = json['value'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'radiatisId': RadiatisId,
        'value': Value
    };

    getTypeName() => "HkEvaluateAttribute";
    TypeContext? context = _ctx;
}

// @DataContract
class EvaluateHkRadiators extends Eras2AppServiceModelBase implements IConvertible
{
    // @DataMember(Name="RadiatorGroupId")
    int? RadiatorGroupId;

    // @DataMember(Name="Parameters")
    List<HkEvaluateParameter>? Parameters;

    // @DataMember(Name="Attributes")
    List<HkEvaluateAttribute>? Attributes;

    // @DataMember(Name="DeviceTypeIdentifier")
    String? DeviceTypeIdentifier;

    // @DataMember(Name="MountingPoint")
    String? MountingPoint;

    // @DataMember(Name="MaxResultSize")
    int? MaxResultSize;

    EvaluateHkRadiators({this.RadiatorGroupId,this.Parameters,this.Attributes,this.DeviceTypeIdentifier,this.MountingPoint,this.MaxResultSize});
    EvaluateHkRadiators.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        RadiatorGroupId = json['radiatorGroupId'];
        Parameters = JsonConverters.fromJson(json['parameters'],'List<HkEvaluateParameter>',context!);
        Attributes = JsonConverters.fromJson(json['attributes'],'List<HkEvaluateAttribute>',context!);
        DeviceTypeIdentifier = json['deviceTypeIdentifier'];
        MountingPoint = json['mountingPoint'];
        MaxResultSize = json['maxResultSize'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'radiatorGroupId': RadiatorGroupId,
        'parameters': JsonConverters.toJson(Parameters,'List<HkEvaluateParameter>',context!),
        'attributes': JsonConverters.toJson(Attributes,'List<HkEvaluateAttribute>',context!),
        'deviceTypeIdentifier': DeviceTypeIdentifier,
        'mountingPoint': MountingPoint,
        'maxResultSize': MaxResultSize
    });

    getTypeName() => "EvaluateHkRadiators";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'messdienstservice_stadtwerke_peine_servamw.eras_online.de', types: <String, TypeInfo> {
    'Eras2AppServiceModelBase': TypeInfo(TypeOf.AbstractClass),
    'HkMatchDifference': TypeInfo(TypeOf.Class, create:() => HkMatchDifference()),
    'HkRadiatorMatch': TypeInfo(TypeOf.Class, create:() => HkRadiatorMatch()),
    'List<HkMatchDifference>': TypeInfo(TypeOf.Class, create:() => <HkMatchDifference>[]),
    'EvaluateHkRadiatorsResponse': TypeInfo(TypeOf.Class, create:() => EvaluateHkRadiatorsResponse()),
    'List<HkRadiatorMatch>': TypeInfo(TypeOf.Class, create:() => <HkRadiatorMatch>[]),
    'HkEvaluateParameter': TypeInfo(TypeOf.Class, create:() => HkEvaluateParameter()),
    'HkEvaluateAttribute': TypeInfo(TypeOf.Class, create:() => HkEvaluateAttribute()),
    'EvaluateHkRadiators': TypeInfo(TypeOf.Class, create:() => EvaluateHkRadiators()),
    'List<HkEvaluateParameter>': TypeInfo(TypeOf.Class, create:() => <HkEvaluateParameter>[]),
    'List<HkEvaluateAttribute>': TypeInfo(TypeOf.Class, create:() => <HkEvaluateAttribute>[]),
});

Dart 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: messdienstservice-stadtwerke-peine-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>