Server

<back to all web services

GetHkReferenceData

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

namespace Eras2Amw.Service.Server.ServiceModel.Common
{
    [DataContract]
    public partial class HkAttribute
    {
        [DataMember(Name="RadiatisId")]
        public virtual int RadiatisId { get; set; }

        [DataMember(Name="Code")]
        public virtual string Code { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Notes")]
        public virtual IList<HkAttributeNote> Notes { get; set; }
    }

    [DataContract]
    public partial class HkAttributeNote
    {
        public HkAttributeNote()
        {
            ImageSlice = new byte[]{};
        }

        [DataMember(Name="NoteId")]
        public virtual int NoteId { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="ImageSlice")]
        public virtual byte[] ImageSlice { get; set; }
    }

    [DataContract]
    public partial class HkGroup
    {
        [DataMember(Name="Id")]
        public virtual int Id { get; set; }

        [DataMember(Name="Number")]
        public virtual int? Number { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Comment")]
        public virtual string Comment { get; set; }

        [DataMember(Name="SectionId")]
        public virtual int? SectionId { get; set; }

        [DataMember(Name="Characteristic")]
        public virtual string Characteristic { get; set; }

        [DataMember(Name="Parameters")]
        public virtual IList<HkParameter> Parameters { get; set; }

        [DataMember(Name="Attributes")]
        public virtual IList<HkAttribute> Attributes { get; set; }

        [DataMember(Name="Images")]
        public virtual IList<byte[]> Images { get; set; }

        [DataMember(Name="Layouts")]
        public virtual IList<HkLayout> Layouts { get; set; }
    }

    [DataContract]
    public partial class HkLayout
    {
        public HkLayout()
        {
            Image = new byte[]{};
        }

        [DataMember(Name="Title")]
        public virtual string Title { get; set; }

        [DataMember(Name="Comment")]
        public virtual string Comment { get; set; }

        [DataMember(Name="Image")]
        public virtual byte[] Image { get; set; }
    }

    [DataContract]
    public partial class HkParameter
    {
        [DataMember(Name="RadiatisId")]
        public virtual int? RadiatisId { get; set; }

        [DataMember(Name="Code")]
        public virtual string Code { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Comment")]
        public virtual string Comment { get; set; }

        [DataMember(Name="Unit")]
        public virtual string Unit { get; set; }

        [DataMember(Name="Mandatory")]
        public virtual bool Mandatory { get; set; }

        [DataMember(Name="Position")]
        public virtual int? Position { get; set; }
    }

    [DataContract]
    public partial class HkSection
    {
        public HkSection()
        {
            Image = new byte[]{};
        }

        [DataMember(Name="Id")]
        public virtual int Id { get; set; }

        [DataMember(Name="Number")]
        public virtual int? Number { get; set; }

        [DataMember(Name="Code")]
        public virtual string Code { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Comment")]
        public virtual string Comment { get; set; }

        [DataMember(Name="Image")]
        public virtual byte[] Image { get; set; }
    }

}

namespace Eras2Amw.Service.Server.ServiceModel.Eras2App
{
    [DataContract]
    public partial class Eras2AppServiceModelBase
    {
        [DataMember(Name="UserId")]
        public virtual Guid UserId { get; set; }
    }

}

namespace Eras2Amw.Service.Server.ServiceModel.Eras2App.Get
{
    [DataContract]
    public partial class GetHkReferenceData
        : Eras2AppServiceModelBase
    {
    }

    [DataContract]
    public partial class GetHkReferenceDataResponse
    {
        [DataMember(Name="LoadedAt")]
        public virtual DateTime LoadedAt { get; set; }

        [DataMember(Name="Sections")]
        public virtual IList<HkSection> Sections { get; set; }

        [DataMember(Name="Groups")]
        public virtual IList<HkGroup> Groups { get; set; }

        [DataMember(Name="ResponseStatus")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetHkReferenceData DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"LoadedAt":"0001-01-01T00:00:00.0000000Z","ResponseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}