Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
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 HkSection() = 
        [<DataMember(Name="Id")>]
        member val Id:Int32 = new Int32() with get,set

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

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

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

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

        [<DataMember(Name="Image")>]
        member val Image:Byte[] = [||] with get,set

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

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

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

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

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

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

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

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

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

        [<DataMember(Name="ImageSlice")>]
        member val ImageSlice:Byte[] = [||] with get,set

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

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

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

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

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

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

        [<DataMember(Name="Image")>]
        member val Image:Byte[] = [||] with get,set

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

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

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

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

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetHkReferenceDataResponse() = 
        [<DataMember(Name="LoadedAt")>]
        member val LoadedAt:DateTime = new DateTime() with get,set

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

        [<DataMember(Name="Groups")>]
        member val Groups:IList<HkGroup> = 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 GetHkReferenceData() = 
        inherit Eras2AppServiceModelBase()

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