Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @DataContract
    public static class GetHkReferenceData extends Eras2AppServiceModelBase
    {
        
    }

    @DataContract
    public static class Eras2AppServiceModelBase
    {
        @DataMember(Name="UserId")
        @SerializedName("UserId")
        public UUID userId = null;
        
        public UUID getUserId() { return userId; }
        public Eras2AppServiceModelBase setUserId(UUID value) { this.userId = value; return this; }
    }

    @DataContract
    public static class GetHkReferenceDataResponse
    {
        @DataMember(Name="LoadedAt")
        @SerializedName("LoadedAt")
        public Date loadedAt = null;

        @DataMember(Name="Sections")
        @SerializedName("Sections")
        public IList<HkSection> sections = null;

        @DataMember(Name="Groups")
        @SerializedName("Groups")
        public IList<HkGroup> groups = null;

        @DataMember(Name="ResponseStatus")
        @SerializedName("ResponseStatus")
        public ResponseStatus responseStatus = null;
        
        public Date getLoadedAt() { return loadedAt; }
        public GetHkReferenceDataResponse setLoadedAt(Date value) { this.loadedAt = value; return this; }
        public IList<HkSection> getSections() { return sections; }
        public GetHkReferenceDataResponse setSections(IList<HkSection> value) { this.sections = value; return this; }
        public IList<HkGroup> getGroups() { return groups; }
        public GetHkReferenceDataResponse setGroups(IList<HkGroup> value) { this.groups = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetHkReferenceDataResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class HkSection
    {
        @DataMember(Name="Id")
        @SerializedName("Id")
        public Integer id = null;

        @DataMember(Name="Number")
        @SerializedName("Number")
        public Integer number = null;

        @DataMember(Name="Code")
        @SerializedName("Code")
        public String code = null;

        @DataMember(Name="Name")
        @SerializedName("Name")
        public String name = null;

        @DataMember(Name="Comment")
        @SerializedName("Comment")
        public String comment = null;

        @DataMember(Name="Image")
        @SerializedName("Image")
        public byte[] image = null;
        
        public Integer getId() { return id; }
        public HkSection setId(Integer value) { this.id = value; return this; }
        public Integer getNumber() { return number; }
        public HkSection setNumber(Integer value) { this.number = value; return this; }
        public String getCode() { return code; }
        public HkSection setCode(String value) { this.code = value; return this; }
        public String getName() { return name; }
        public HkSection setName(String value) { this.name = value; return this; }
        public String getComment() { return comment; }
        public HkSection setComment(String value) { this.comment = value; return this; }
        public byte[] getImage() { return image; }
        public HkSection setImage(byte[] value) { this.image = value; return this; }
    }

    @DataContract
    public static class HkGroup
    {
        @DataMember(Name="Id")
        @SerializedName("Id")
        public Integer id = null;

        @DataMember(Name="Number")
        @SerializedName("Number")
        public Integer number = null;

        @DataMember(Name="Name")
        @SerializedName("Name")
        public String name = null;

        @DataMember(Name="Comment")
        @SerializedName("Comment")
        public String comment = null;

        @DataMember(Name="SectionId")
        @SerializedName("SectionId")
        public Integer sectionId = null;

        @DataMember(Name="Characteristic")
        @SerializedName("Characteristic")
        public String characteristic = null;

        @DataMember(Name="Parameters")
        @SerializedName("Parameters")
        public IList<HkParameter> parameters = null;

        @DataMember(Name="Attributes")
        @SerializedName("Attributes")
        public IList<HkAttribute> attributes = null;

        @DataMember(Name="Images")
        @SerializedName("Images")
        public IList<byte[]> images = null;

        @DataMember(Name="Layouts")
        @SerializedName("Layouts")
        public IList<HkLayout> layouts = null;
        
        public Integer getId() { return id; }
        public HkGroup setId(Integer value) { this.id = value; return this; }
        public Integer getNumber() { return number; }
        public HkGroup setNumber(Integer value) { this.number = value; return this; }
        public String getName() { return name; }
        public HkGroup setName(String value) { this.name = value; return this; }
        public String getComment() { return comment; }
        public HkGroup setComment(String value) { this.comment = value; return this; }
        public Integer getSectionId() { return sectionId; }
        public HkGroup setSectionId(Integer value) { this.sectionId = value; return this; }
        public String getCharacteristic() { return characteristic; }
        public HkGroup setCharacteristic(String value) { this.characteristic = value; return this; }
        public IList<HkParameter> getParameters() { return parameters; }
        public HkGroup setParameters(IList<HkParameter> value) { this.parameters = value; return this; }
        public IList<HkAttribute> getAttributes() { return attributes; }
        public HkGroup setAttributes(IList<HkAttribute> value) { this.attributes = value; return this; }
        public IList<byte[]> getImages() { return images; }
        public HkGroup setImages(IList<byte[]> value) { this.images = value; return this; }
        public IList<HkLayout> getLayouts() { return layouts; }
        public HkGroup setLayouts(IList<HkLayout> value) { this.layouts = value; return this; }
    }

    @DataContract
    public static class HkParameter
    {
        @DataMember(Name="RadiatisId")
        @SerializedName("RadiatisId")
        public Integer radiatisId = null;

        @DataMember(Name="Code")
        @SerializedName("Code")
        public String code = null;

        @DataMember(Name="Name")
        @SerializedName("Name")
        public String name = null;

        @DataMember(Name="Comment")
        @SerializedName("Comment")
        public String comment = null;

        @DataMember(Name="Unit")
        @SerializedName("Unit")
        public String unit = null;

        @DataMember(Name="Mandatory")
        @SerializedName("Mandatory")
        public Boolean mandatory = null;

        @DataMember(Name="Position")
        @SerializedName("Position")
        public Integer position = null;
        
        public Integer getRadiatisId() { return radiatisId; }
        public HkParameter setRadiatisId(Integer value) { this.radiatisId = value; return this; }
        public String getCode() { return code; }
        public HkParameter setCode(String value) { this.code = value; return this; }
        public String getName() { return name; }
        public HkParameter setName(String value) { this.name = value; return this; }
        public String getComment() { return comment; }
        public HkParameter setComment(String value) { this.comment = value; return this; }
        public String getUnit() { return unit; }
        public HkParameter setUnit(String value) { this.unit = value; return this; }
        public Boolean isMandatory() { return mandatory; }
        public HkParameter setMandatory(Boolean value) { this.mandatory = value; return this; }
        public Integer getPosition() { return position; }
        public HkParameter setPosition(Integer value) { this.position = value; return this; }
    }

    @DataContract
    public static class HkAttribute
    {
        @DataMember(Name="RadiatisId")
        @SerializedName("RadiatisId")
        public Integer radiatisId = null;

        @DataMember(Name="Code")
        @SerializedName("Code")
        public String code = null;

        @DataMember(Name="Name")
        @SerializedName("Name")
        public String name = null;

        @DataMember(Name="Notes")
        @SerializedName("Notes")
        public IList<HkAttributeNote> notes = null;
        
        public Integer getRadiatisId() { return radiatisId; }
        public HkAttribute setRadiatisId(Integer value) { this.radiatisId = value; return this; }
        public String getCode() { return code; }
        public HkAttribute setCode(String value) { this.code = value; return this; }
        public String getName() { return name; }
        public HkAttribute setName(String value) { this.name = value; return this; }
        public IList<HkAttributeNote> getNotes() { return notes; }
        public HkAttribute setNotes(IList<HkAttributeNote> value) { this.notes = value; return this; }
    }

    @DataContract
    public static class HkAttributeNote
    {
        @DataMember(Name="NoteId")
        @SerializedName("NoteId")
        public Integer noteId = null;

        @DataMember(Name="Name")
        @SerializedName("Name")
        public String name = null;

        @DataMember(Name="ImageSlice")
        @SerializedName("ImageSlice")
        public byte[] imageSlice = null;
        
        public Integer getNoteId() { return noteId; }
        public HkAttributeNote setNoteId(Integer value) { this.noteId = value; return this; }
        public String getName() { return name; }
        public HkAttributeNote setName(String value) { this.name = value; return this; }
        public byte[] getImageSlice() { return imageSlice; }
        public HkAttributeNote setImageSlice(byte[] value) { this.imageSlice = value; return this; }
    }

    @DataContract
    public static class HkLayout
    {
        @DataMember(Name="Title")
        @SerializedName("Title")
        public String title = null;

        @DataMember(Name="Comment")
        @SerializedName("Comment")
        public String comment = null;

        @DataMember(Name="Image")
        @SerializedName("Image")
        public byte[] image = null;
        
        public String getTitle() { return title; }
        public HkLayout setTitle(String value) { this.title = value; return this; }
        public String getComment() { return comment; }
        public HkLayout setComment(String value) { this.comment = value; return this; }
        public byte[] getImage() { return image; }
        public HkLayout setImage(byte[] value) { this.image = value; return this; }
    }

}

Java 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: fairtherm-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"}}}