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 .csv suffix or ?format=csv

HTTP + CSV

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: kromer-servamw.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}