Server

<back to all web services

EvaluateHkRadiators

Requires Authentication
The following routes are available for this service:
POST/App/{UserId}/HkEvaluate
namespace Eras2Amw.Service.Server.ServiceModel.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkMatchDifference() = 
        [<DataMember(Name="Code")>]
        member val Code:String = null with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Value")>]
        member val Value:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkRadiatorMatch() = 
        [<DataMember(Name="Match")>]
        member val Match:Int32 = new Int32() with get,set

        [<DataMember(Name="RadiatisRadiatorId")>]
        member val RadiatisRadiatorId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Name="Producer")>]
        member val Producer:String = null with get,set

        [<DataMember(Name="Model")>]
        member val Model:String = null with get,set

        [<DataMember(Name="ModelNoteReference")>]
        member val ModelNoteReference:String = null with get,set

        [<DataMember(Name="KcValue")>]
        member val KcValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember(Name="KqValue")>]
        member val KqValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember(Name="KtValue")>]
        member val KtValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember(Name="Differences")>]
        member val Differences:IList<HkMatchDifference> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type EvaluateHkRadiatorsResponse() = 
        [<DataMember(Name="Radiators")>]
        member val Radiators:IList<HkRadiatorMatch> = null with get,set

        [<DataMember(Name="ResponseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Eras2AppServiceModelBase() = 
        [<DataMember(Name="UserId")>]
        member val UserId:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkEvaluateParameter() = 
        [<DataMember(Name="RadiatisId")>]
        member val RadiatisId:Int32 = new Int32() with get,set

        [<DataMember(Name="Value")>]
        member val Value:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkEvaluateAttribute() = 
        [<DataMember(Name="RadiatisId")>]
        member val RadiatisId:Int32 = new Int32() with get,set

        [<DataMember(Name="Value")>]
        member val Value:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type EvaluateHkRadiators() = 
        inherit Eras2AppServiceModelBase()
        [<DataMember(Name="RadiatorGroupId")>]
        member val RadiatorGroupId:Int32 = new Int32() with get,set

        [<DataMember(Name="Parameters")>]
        member val Parameters:IList<HkEvaluateParameter> = null with get,set

        [<DataMember(Name="Attributes")>]
        member val Attributes:IList<HkEvaluateAttribute> = null with get,set

        [<DataMember(Name="DeviceTypeIdentifier")>]
        member val DeviceTypeIdentifier:String = null with get,set

        [<DataMember(Name="MountingPoint")>]
        member val MountingPoint:String = null with get,set

        [<DataMember(Name="MaxResultSize")>]
        member val MaxResultSize:Int32 = new Int32() with get,set

F# 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>