Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class Eras2AppServiceModelBase
{
    // @DataMember(Name="UserId")
    String? UserId;

    Eras2AppServiceModelBase({this.UserId});
    Eras2AppServiceModelBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserId = json['userId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': UserId
    };

    getTypeName() => "Eras2AppServiceModelBase";
    TypeContext? context = _ctx;
}

// @DataContract
class HkSection implements IConvertible
{
    // @DataMember(Name="Id")
    int? Id;

    // @DataMember(Name="Number")
    int? Number;

    // @DataMember(Name="Code")
    String? Code;

    // @DataMember(Name="Name")
    String? Name;

    // @DataMember(Name="Comment")
    String? Comment;

    // @DataMember(Name="Image")
    Uint8List? Image;

    HkSection({this.Id,this.Number,this.Code,this.Name,this.Comment,this.Image});
    HkSection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['id'];
        Number = json['number'];
        Code = json['code'];
        Name = json['name'];
        Comment = json['comment'];
        Image = JsonConverters.fromJson(json['image'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': Id,
        'number': Number,
        'code': Code,
        'name': Name,
        'comment': Comment,
        'image': JsonConverters.toJson(Image,'Uint8List',context!)
    };

    getTypeName() => "HkSection";
    TypeContext? context = _ctx;
}

// @DataContract
class HkParameter implements IConvertible
{
    // @DataMember(Name="RadiatisId")
    int? RadiatisId;

    // @DataMember(Name="Code")
    String? Code;

    // @DataMember(Name="Name")
    String? Name;

    // @DataMember(Name="Comment")
    String? Comment;

    // @DataMember(Name="Unit")
    String? Unit;

    // @DataMember(Name="Mandatory")
    bool? Mandatory;

    // @DataMember(Name="Position")
    int? Position;

    HkParameter({this.RadiatisId,this.Code,this.Name,this.Comment,this.Unit,this.Mandatory,this.Position});
    HkParameter.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RadiatisId = json['radiatisId'];
        Code = json['code'];
        Name = json['name'];
        Comment = json['comment'];
        Unit = json['unit'];
        Mandatory = json['mandatory'];
        Position = json['position'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'radiatisId': RadiatisId,
        'code': Code,
        'name': Name,
        'comment': Comment,
        'unit': Unit,
        'mandatory': Mandatory,
        'position': Position
    };

    getTypeName() => "HkParameter";
    TypeContext? context = _ctx;
}

// @DataContract
class HkAttributeNote implements IConvertible
{
    // @DataMember(Name="NoteId")
    int? NoteId;

    // @DataMember(Name="Name")
    String? Name;

    // @DataMember(Name="ImageSlice")
    Uint8List? ImageSlice;

    HkAttributeNote({this.NoteId,this.Name,this.ImageSlice});
    HkAttributeNote.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NoteId = json['noteId'];
        Name = json['name'];
        ImageSlice = JsonConverters.fromJson(json['imageSlice'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'noteId': NoteId,
        'name': Name,
        'imageSlice': JsonConverters.toJson(ImageSlice,'Uint8List',context!)
    };

    getTypeName() => "HkAttributeNote";
    TypeContext? context = _ctx;
}

// @DataContract
class HkAttribute implements IConvertible
{
    // @DataMember(Name="RadiatisId")
    int? RadiatisId;

    // @DataMember(Name="Code")
    String? Code;

    // @DataMember(Name="Name")
    String? Name;

    // @DataMember(Name="Notes")
    List<HkAttributeNote>? Notes;

    HkAttribute({this.RadiatisId,this.Code,this.Name,this.Notes});
    HkAttribute.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RadiatisId = json['radiatisId'];
        Code = json['code'];
        Name = json['name'];
        Notes = JsonConverters.fromJson(json['notes'],'List<HkAttributeNote>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'radiatisId': RadiatisId,
        'code': Code,
        'name': Name,
        'notes': JsonConverters.toJson(Notes,'List<HkAttributeNote>',context!)
    };

    getTypeName() => "HkAttribute";
    TypeContext? context = _ctx;
}

// @DataContract
class HkLayout implements IConvertible
{
    // @DataMember(Name="Title")
    String? Title;

    // @DataMember(Name="Comment")
    String? Comment;

    // @DataMember(Name="Image")
    Uint8List? Image;

    HkLayout({this.Title,this.Comment,this.Image});
    HkLayout.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Title = json['title'];
        Comment = json['comment'];
        Image = JsonConverters.fromJson(json['image'],'Uint8List',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'title': Title,
        'comment': Comment,
        'image': JsonConverters.toJson(Image,'Uint8List',context!)
    };

    getTypeName() => "HkLayout";
    TypeContext? context = _ctx;
}

// @DataContract
class HkGroup implements IConvertible
{
    // @DataMember(Name="Id")
    int? Id;

    // @DataMember(Name="Number")
    int? Number;

    // @DataMember(Name="Name")
    String? Name;

    // @DataMember(Name="Comment")
    String? Comment;

    // @DataMember(Name="SectionId")
    int? SectionId;

    // @DataMember(Name="Characteristic")
    String? Characteristic;

    // @DataMember(Name="Parameters")
    List<HkParameter>? Parameters;

    // @DataMember(Name="Attributes")
    List<HkAttribute>? Attributes;

    // @DataMember(Name="Images")
    List<Uint8List>? Images;

    // @DataMember(Name="Layouts")
    List<HkLayout>? Layouts;

    HkGroup({this.Id,this.Number,this.Name,this.Comment,this.SectionId,this.Characteristic,this.Parameters,this.Attributes,this.Images,this.Layouts});
    HkGroup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['id'];
        Number = json['number'];
        Name = json['name'];
        Comment = json['comment'];
        SectionId = json['sectionId'];
        Characteristic = json['characteristic'];
        Parameters = JsonConverters.fromJson(json['parameters'],'List<HkParameter>',context!);
        Attributes = JsonConverters.fromJson(json['attributes'],'List<HkAttribute>',context!);
        Images = JsonConverters.fromJson(json['images'],'List<Uint8List>',context!);
        Layouts = JsonConverters.fromJson(json['layouts'],'List<HkLayout>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': Id,
        'number': Number,
        'name': Name,
        'comment': Comment,
        'sectionId': SectionId,
        'characteristic': Characteristic,
        'parameters': JsonConverters.toJson(Parameters,'List<HkParameter>',context!),
        'attributes': JsonConverters.toJson(Attributes,'List<HkAttribute>',context!),
        'images': JsonConverters.toJson(Images,'List<Uint8List>',context!),
        'layouts': JsonConverters.toJson(Layouts,'List<HkLayout>',context!)
    };

    getTypeName() => "HkGroup";
    TypeContext? context = _ctx;
}

// @DataContract
class GetHkReferenceDataResponse implements IConvertible
{
    // @DataMember(Name="LoadedAt")
    DateTime? LoadedAt;

    // @DataMember(Name="Sections")
    List<HkSection>? Sections;

    // @DataMember(Name="Groups")
    List<HkGroup>? Groups;

    // @DataMember(Name="ResponseStatus")
    ResponseStatus? ResponseStatus;

    GetHkReferenceDataResponse({this.LoadedAt,this.Sections,this.Groups,this.ResponseStatus});
    GetHkReferenceDataResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        LoadedAt = JsonConverters.fromJson(json['loadedAt'],'DateTime',context!);
        Sections = JsonConverters.fromJson(json['sections'],'List<HkSection>',context!);
        Groups = JsonConverters.fromJson(json['groups'],'List<HkGroup>',context!);
        ResponseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'loadedAt': JsonConverters.toJson(LoadedAt,'DateTime',context!),
        'sections': JsonConverters.toJson(Sections,'List<HkSection>',context!),
        'groups': JsonConverters.toJson(Groups,'List<HkGroup>',context!),
        'responseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetHkReferenceDataResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class GetHkReferenceData extends Eras2AppServiceModelBase implements IConvertible
{
    GetHkReferenceData();
    GetHkReferenceData.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetHkReferenceData";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'messdienstservice_stadtwerke_peine_servamw.eras_online.de', types: <String, TypeInfo> {
    'Eras2AppServiceModelBase': TypeInfo(TypeOf.AbstractClass),
    'HkSection': TypeInfo(TypeOf.Class, create:() => HkSection()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'HkParameter': TypeInfo(TypeOf.Class, create:() => HkParameter()),
    'HkAttributeNote': TypeInfo(TypeOf.Class, create:() => HkAttributeNote()),
    'HkAttribute': TypeInfo(TypeOf.Class, create:() => HkAttribute()),
    'List<HkAttributeNote>': TypeInfo(TypeOf.Class, create:() => <HkAttributeNote>[]),
    'HkLayout': TypeInfo(TypeOf.Class, create:() => HkLayout()),
    'HkGroup': TypeInfo(TypeOf.Class, create:() => HkGroup()),
    'List<HkParameter>': TypeInfo(TypeOf.Class, create:() => <HkParameter>[]),
    'List<HkAttribute>': TypeInfo(TypeOf.Class, create:() => <HkAttribute>[]),
    'List<Uint8List>': TypeInfo(TypeOf.Class, create:() => <Uint8List>[]),
    'List<HkLayout>': TypeInfo(TypeOf.Class, create:() => <HkLayout>[]),
    'GetHkReferenceDataResponse': TypeInfo(TypeOf.Class, create:() => GetHkReferenceDataResponse()),
    'List<HkSection>': TypeInfo(TypeOf.Class, create:() => <HkSection>[]),
    'List<HkGroup>': TypeInfo(TypeOf.Class, create:() => <HkGroup>[]),
    'GetHkReferenceData': TypeInfo(TypeOf.Class, create:() => GetHkReferenceData()),
});

Dart 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: messdienstservice-stadtwerke-peine-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>