Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Eras2AppServiceModelBase:
    user_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkSection:
    id: int = 0
    number: Optional[int] = None
    code: Optional[str] = None
    name: Optional[str] = None
    comment: Optional[str] = None
    image: Optional[bytes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkParameter:
    radiatis_id: Optional[int] = None
    code: Optional[str] = None
    name: Optional[str] = None
    comment: Optional[str] = None
    unit: Optional[str] = None
    mandatory: bool = False
    position: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkAttributeNote:
    note_id: int = 0
    name: Optional[str] = None
    image_slice: Optional[bytes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkAttribute:
    radiatis_id: int = 0
    code: Optional[str] = None
    name: Optional[str] = None
    notes: Optional[IList[HkAttributeNote]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkLayout:
    title: Optional[str] = None
    comment: Optional[str] = None
    image: Optional[bytes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HkGroup:
    id: int = 0
    number: Optional[int] = None
    name: Optional[str] = None
    comment: Optional[str] = None
    section_id: Optional[int] = None
    characteristic: Optional[str] = None
    parameters: Optional[IList[HkParameter]] = None
    attributes: Optional[IList[HkAttribute]] = None
    images: Optional[IList[bytes]] = None
    layouts: Optional[IList[HkLayout]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetHkReferenceDataResponse:
    loaded_at: datetime.datetime = datetime.datetime(1, 1, 1)
    sections: Optional[IList[HkSection]] = None
    groups: Optional[IList[HkGroup]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetHkReferenceData(Eras2AppServiceModelBase):
    pass

Python 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: imm-con-gmbh-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"}}}