Server

<back to all web services

GetHkReferenceData

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

// @DataContract
export class Eras2AppServiceModelBase
{
    // @DataMember(Name="UserId")
    public UserId: string;

    public constructor(init?: Partial<Eras2AppServiceModelBase>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkSection
{
    // @DataMember(Name="Id")
    public Id: number;

    // @DataMember(Name="Number")
    public Number?: number;

    // @DataMember(Name="Code")
    public Code: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Comment")
    public Comment: string;

    // @DataMember(Name="Image")
    public Image: string;

    public constructor(init?: Partial<HkSection>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkParameter
{
    // @DataMember(Name="RadiatisId")
    public RadiatisId?: number;

    // @DataMember(Name="Code")
    public Code: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Comment")
    public Comment: string;

    // @DataMember(Name="Unit")
    public Unit: string;

    // @DataMember(Name="Mandatory")
    public Mandatory: boolean;

    // @DataMember(Name="Position")
    public Position?: number;

    public constructor(init?: Partial<HkParameter>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkAttributeNote
{
    // @DataMember(Name="NoteId")
    public NoteId: number;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="ImageSlice")
    public ImageSlice: string;

    public constructor(init?: Partial<HkAttributeNote>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkAttribute
{
    // @DataMember(Name="RadiatisId")
    public RadiatisId: number;

    // @DataMember(Name="Code")
    public Code: string;

    // @DataMember(Name="Name")
    public Name: string;

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

    public constructor(init?: Partial<HkAttribute>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkLayout
{
    // @DataMember(Name="Title")
    public Title: string;

    // @DataMember(Name="Comment")
    public Comment: string;

    // @DataMember(Name="Image")
    public Image: string;

    public constructor(init?: Partial<HkLayout>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HkGroup
{
    // @DataMember(Name="Id")
    public Id: number;

    // @DataMember(Name="Number")
    public Number?: number;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Comment")
    public Comment: string;

    // @DataMember(Name="SectionId")
    public SectionId?: number;

    // @DataMember(Name="Characteristic")
    public Characteristic: string;

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

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

    // @DataMember(Name="Images")
    public Images: IList<string>;

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

    public constructor(init?: Partial<HkGroup>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetHkReferenceDataResponse
{
    // @DataMember(Name="LoadedAt")
    public LoadedAt: string;

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

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

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

    public constructor(init?: Partial<GetHkReferenceDataResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetHkReferenceData extends Eras2AppServiceModelBase
{

    public constructor(init?: Partial<GetHkReferenceData>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetHkReferenceData DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: heat-syke-servamw.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	LoadedAt: 0001-01-01T00:00:00Z,
	ResponseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}