Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
"use strict";
export class Eras2AppServiceModelBase {
    /** @param {{UserId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
}
export class HkSection {
    /** @param {{Id?:number,Number?:number,Code?:string,Name?:string,Comment?:string,Image?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {?number} */
    Number;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Comment;
    /** @type {string} */
    Image;
}
export class HkParameter {
    /** @param {{RadiatisId?:number,Code?:string,Name?:string,Comment?:string,Unit?:string,Mandatory?:boolean,Position?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    RadiatisId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Comment;
    /** @type {string} */
    Unit;
    /** @type {boolean} */
    Mandatory;
    /** @type {?number} */
    Position;
}
export class HkAttributeNote {
    /** @param {{NoteId?:number,Name?:string,ImageSlice?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NoteId;
    /** @type {string} */
    Name;
    /** @type {string} */
    ImageSlice;
}
export class HkAttribute {
    /** @param {{RadiatisId?:number,Code?:string,Name?:string,Notes?:IList<HkAttributeNote>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RadiatisId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {IList<HkAttributeNote>} */
    Notes;
}
export class HkLayout {
    /** @param {{Title?:string,Comment?:string,Image?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Title;
    /** @type {string} */
    Comment;
    /** @type {string} */
    Image;
}
export class HkGroup {
    /** @param {{Id?:number,Number?:number,Name?:string,Comment?:string,SectionId?:number,Characteristic?:string,Parameters?:IList<HkParameter>,Attributes?:IList<HkAttribute>,Images?:IList<string>,Layouts?:IList<HkLayout>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {?number} */
    Number;
    /** @type {string} */
    Name;
    /** @type {string} */
    Comment;
    /** @type {?number} */
    SectionId;
    /** @type {string} */
    Characteristic;
    /** @type {IList<HkParameter>} */
    Parameters;
    /** @type {IList<HkAttribute>} */
    Attributes;
    /** @type {IList<string>} */
    Images;
    /** @type {IList<HkLayout>} */
    Layouts;
}
export class GetHkReferenceDataResponse {
    /** @param {{LoadedAt?:string,Sections?:IList<HkSection>,Groups?:IList<HkGroup>,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LoadedAt;
    /** @type {IList<HkSection>} */
    Sections;
    /** @type {IList<HkGroup>} */
    Groups;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetHkReferenceData extends Eras2AppServiceModelBase {
    /** @param {{UserId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript 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: concept2021-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
		}
	}
}