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 .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: dumpro-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>