Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetHkReferenceData : Eras2AppServiceModelBase()
{
}

@DataContract
open class Eras2AppServiceModelBase
{
    @DataMember(Name="UserId")
    @SerializedName("UserId")
    var userId:UUID? = null
}

@DataContract
open class GetHkReferenceDataResponse
{
    @DataMember(Name="LoadedAt")
    @SerializedName("LoadedAt")
    var loadedAt:Date? = null

    @DataMember(Name="Sections")
    @SerializedName("Sections")
    var sections:IList<HkSection>? = null

    @DataMember(Name="Groups")
    @SerializedName("Groups")
    var groups:IList<HkGroup>? = null

    @DataMember(Name="ResponseStatus")
    @SerializedName("ResponseStatus")
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class HkSection
{
    @DataMember(Name="Id")
    @SerializedName("Id")
    var id:Int? = null

    @DataMember(Name="Number")
    @SerializedName("Number")
    var number:Int? = null

    @DataMember(Name="Code")
    @SerializedName("Code")
    var code:String? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="Comment")
    @SerializedName("Comment")
    var comment:String? = null

    @DataMember(Name="Image")
    @SerializedName("Image")
    var image:ByteArray? = null
}

@DataContract
open class HkGroup
{
    @DataMember(Name="Id")
    @SerializedName("Id")
    var id:Int? = null

    @DataMember(Name="Number")
    @SerializedName("Number")
    var number:Int? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="Comment")
    @SerializedName("Comment")
    var comment:String? = null

    @DataMember(Name="SectionId")
    @SerializedName("SectionId")
    var sectionId:Int? = null

    @DataMember(Name="Characteristic")
    @SerializedName("Characteristic")
    var characteristic:String? = null

    @DataMember(Name="Parameters")
    @SerializedName("Parameters")
    var parameters:IList<HkParameter>? = null

    @DataMember(Name="Attributes")
    @SerializedName("Attributes")
    var attributes:IList<HkAttribute>? = null

    @DataMember(Name="Images")
    @SerializedName("Images")
    var images:IList<ByteArray>? = null

    @DataMember(Name="Layouts")
    @SerializedName("Layouts")
    var layouts:IList<HkLayout>? = null
}

@DataContract
open class HkParameter
{
    @DataMember(Name="RadiatisId")
    @SerializedName("RadiatisId")
    var radiatisId:Int? = null

    @DataMember(Name="Code")
    @SerializedName("Code")
    var code:String? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="Comment")
    @SerializedName("Comment")
    var comment:String? = null

    @DataMember(Name="Unit")
    @SerializedName("Unit")
    var unit:String? = null

    @DataMember(Name="Mandatory")
    @SerializedName("Mandatory")
    var mandatory:Boolean? = null

    @DataMember(Name="Position")
    @SerializedName("Position")
    var position:Int? = null
}

@DataContract
open class HkAttribute
{
    @DataMember(Name="RadiatisId")
    @SerializedName("RadiatisId")
    var radiatisId:Int? = null

    @DataMember(Name="Code")
    @SerializedName("Code")
    var code:String? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="Notes")
    @SerializedName("Notes")
    var notes:IList<HkAttributeNote>? = null
}

@DataContract
open class HkAttributeNote
{
    @DataMember(Name="NoteId")
    @SerializedName("NoteId")
    var noteId:Int? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="ImageSlice")
    @SerializedName("ImageSlice")
    var imageSlice:ByteArray? = null
}

@DataContract
open class HkLayout
{
    @DataMember(Name="Title")
    @SerializedName("Title")
    var title:String? = null

    @DataMember(Name="Comment")
    @SerializedName("Comment")
    var comment:String? = null

    @DataMember(Name="Image")
    @SerializedName("Image")
    var image:ByteArray? = null
}

Kotlin 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: marneth-messdienst-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>