Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Amw.Service.Server.ServiceModel.Eras2App.Get
Imports Eras2Amw.Service.Server.ServiceModel.Eras2App
Imports Eras2Amw.Service.Server.ServiceModel.Common

Namespace Global

    Namespace Eras2Amw.Service.Server.ServiceModel.Common

        <DataContract>
        Public Partial Class HkAttribute
            <DataMember(Name:="RadiatisId")>
            Public Overridable Property RadiatisId As Integer

            <DataMember(Name:="Code")>
            Public Overridable Property Code As String

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="Notes")>
            Public Overridable Property Notes As IList(Of HkAttributeNote)
        End Class

        <DataContract>
        Public Partial Class HkAttributeNote
            Public Sub New()
                ImageSlice = New Byte(){}
            End Sub

            <DataMember(Name:="NoteId")>
            Public Overridable Property NoteId As Integer

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="ImageSlice")>
            Public Overridable Property ImageSlice As Byte()
        End Class

        <DataContract>
        Public Partial Class HkGroup
            <DataMember(Name:="Id")>
            Public Overridable Property Id As Integer

            <DataMember(Name:="Number")>
            Public Overridable Property Number As Nullable(Of Integer)

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="Comment")>
            Public Overridable Property Comment As String

            <DataMember(Name:="SectionId")>
            Public Overridable Property SectionId As Nullable(Of Integer)

            <DataMember(Name:="Characteristic")>
            Public Overridable Property Characteristic As String

            <DataMember(Name:="Parameters")>
            Public Overridable Property Parameters As IList(Of HkParameter)

            <DataMember(Name:="Attributes")>
            Public Overridable Property Attributes As IList(Of HkAttribute)

            <DataMember(Name:="Images")>
            Public Overridable Property Images As IList(Of Byte())

            <DataMember(Name:="Layouts")>
            Public Overridable Property Layouts As IList(Of HkLayout)
        End Class

        <DataContract>
        Public Partial Class HkLayout
            Public Sub New()
                Image = New Byte(){}
            End Sub

            <DataMember(Name:="Title")>
            Public Overridable Property Title As String

            <DataMember(Name:="Comment")>
            Public Overridable Property Comment As String

            <DataMember(Name:="Image")>
            Public Overridable Property Image As Byte()
        End Class

        <DataContract>
        Public Partial Class HkParameter
            <DataMember(Name:="RadiatisId")>
            Public Overridable Property RadiatisId As Nullable(Of Integer)

            <DataMember(Name:="Code")>
            Public Overridable Property Code As String

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="Comment")>
            Public Overridable Property Comment As String

            <DataMember(Name:="Unit")>
            Public Overridable Property Unit As String

            <DataMember(Name:="Mandatory")>
            Public Overridable Property Mandatory As Boolean

            <DataMember(Name:="Position")>
            Public Overridable Property Position As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class HkSection
            Public Sub New()
                Image = New Byte(){}
            End Sub

            <DataMember(Name:="Id")>
            Public Overridable Property Id As Integer

            <DataMember(Name:="Number")>
            Public Overridable Property Number As Nullable(Of Integer)

            <DataMember(Name:="Code")>
            Public Overridable Property Code As String

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="Comment")>
            Public Overridable Property Comment As String

            <DataMember(Name:="Image")>
            Public Overridable Property Image As Byte()
        End Class
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2App

        <DataContract>
        Public Partial Class Eras2AppServiceModelBase
            <DataMember(Name:="UserId")>
            Public Overridable Property UserId As Guid
        End Class
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2App.Get

        <DataContract>
        Public Partial Class GetHkReferenceData
            Inherits Eras2AppServiceModelBase
        End Class

        <DataContract>
        Public Partial Class GetHkReferenceDataResponse
            <DataMember(Name:="LoadedAt")>
            Public Overridable Property LoadedAt As Date

            <DataMember(Name:="Sections")>
            Public Overridable Property Sections As IList(Of HkSection)

            <DataMember(Name:="Groups")>
            Public Overridable Property Groups As IList(Of HkGroup)

            <DataMember(Name:="ResponseStatus")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetHkReferenceData 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.

GET /App/{UserId}/HkReferenceData HTTP/1.1 
Host: mi-waerme-servamw.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetHkReferenceDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <Groups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
  <LoadedAt>0001-01-01T00:00:00</LoadedAt>
  <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>
  <Sections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common" i:nil="true" />
</GetHkReferenceDataResponse>