Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
import Foundation
import ServiceStack

// @DataContract
public class GetHkReferenceData : Eras2AppServiceModelBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class Eras2AppServiceModelBase : Codable
{
    // @DataMember(Name="UserId")
    public var UserId:String

    required public init(){}
}

// @DataContract
public class GetHkReferenceDataResponse : Codable
{
    // @DataMember(Name="LoadedAt")
    public var LoadedAt:Date

    // @DataMember(Name="Sections")
    public var Sections:IList<HkSection>

    // @DataMember(Name="Groups")
    public var Groups:IList<HkGroup>

    // @DataMember(Name="ResponseStatus")
    public var ResponseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class HkSection : Codable
{
    // @DataMember(Name="Id")
    public var Id:Int

    // @DataMember(Name="Number")
    public var Number:Int?

    // @DataMember(Name="Code")
    public var Code:String

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Comment")
    public var Comment:String

    // @DataMember(Name="Image")
    public var Image:[UInt8] = []

    required public init(){}
}

// @DataContract
public class HkGroup : Codable
{
    // @DataMember(Name="Id")
    public var Id:Int

    // @DataMember(Name="Number")
    public var Number:Int?

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Comment")
    public var Comment:String

    // @DataMember(Name="SectionId")
    public var SectionId:Int?

    // @DataMember(Name="Characteristic")
    public var Characteristic:String

    // @DataMember(Name="Parameters")
    public var Parameters:IList<HkParameter>

    // @DataMember(Name="Attributes")
    public var Attributes:IList<HkAttribute>

    // @DataMember(Name="Images")
    public var Images:IList<[UInt8]>

    // @DataMember(Name="Layouts")
    public var Layouts:IList<HkLayout>

    required public init(){}
}

// @DataContract
public class HkParameter : Codable
{
    // @DataMember(Name="RadiatisId")
    public var RadiatisId:Int?

    // @DataMember(Name="Code")
    public var Code:String

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Comment")
    public var Comment:String

    // @DataMember(Name="Unit")
    public var Unit:String

    // @DataMember(Name="Mandatory")
    public var Mandatory:Bool

    // @DataMember(Name="Position")
    public var Position:Int?

    required public init(){}
}

// @DataContract
public class HkAttribute : Codable
{
    // @DataMember(Name="RadiatisId")
    public var RadiatisId:Int

    // @DataMember(Name="Code")
    public var Code:String

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Notes")
    public var Notes:IList<HkAttributeNote>

    required public init(){}
}

// @DataContract
public class HkAttributeNote : Codable
{
    // @DataMember(Name="NoteId")
    public var NoteId:Int

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="ImageSlice")
    public var ImageSlice:[UInt8] = []

    required public init(){}
}

// @DataContract
public class HkLayout : Codable
{
    // @DataMember(Name="Title")
    public var Title:String

    // @DataMember(Name="Comment")
    public var Comment:String

    // @DataMember(Name="Image")
    public var Image:[UInt8] = []

    required public init(){}
}


Swift 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>