Server

<back to all web services

GetHkReferenceData

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/HkReferenceData
Eras2AppServiceModelBase Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
GetHkReferenceDataResponse Parameters:
NameParameterData TypeRequiredDescription
LoadedAtformDateTimeNo
SectionsformIList<HkSection>No
GroupsformIList<HkGroup>No
ResponseStatusformResponseStatusNo
HkSection Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
Numberformint?No
CodeformstringNo
NameformstringNo
CommentformstringNo
Imageformbyte[]No
HkGroup Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
Numberformint?No
NameformstringNo
CommentformstringNo
SectionIdformint?No
CharacteristicformstringNo
ParametersformIList<HkParameter>No
AttributesformIList<HkAttribute>No
ImagesformIList<byte[]>No
LayoutsformIList<HkLayout>No
HkParameter Parameters:
NameParameterData TypeRequiredDescription
RadiatisIdformint?No
CodeformstringNo
NameformstringNo
CommentformstringNo
UnitformstringNo
MandatoryformboolNo
Positionformint?No
HkAttribute Parameters:
NameParameterData TypeRequiredDescription
RadiatisIdformintNo
CodeformstringNo
NameformstringNo
NotesformIList<HkAttributeNote>No
HkAttributeNote Parameters:
NameParameterData TypeRequiredDescription
NoteIdformintNo
NameformstringNo
ImageSliceformbyte[]No
HkLayout Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
CommentformstringNo
Imageformbyte[]No

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