Server

GetHkReferenceData

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

namespace Eras2Amw.Service.Server.ServiceModel.Common

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkSection() = 
        [<DataMember(Name="Id")>]
        member val Id:Int32 = new Int32() with get,set

        [<DataMember(Name="Number")>]
        member val Number:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Name="Code")>]
        member val Code:String = null with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Comment")>]
        member val Comment:String = null with get,set

        [<DataMember(Name="Image")>]
        member val Image:Byte[] = [||] with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkParameter() = 
        [<DataMember(Name="RadiatisId")>]
        member val RadiatisId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Name="Code")>]
        member val Code:String = null with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Comment")>]
        member val Comment:String = null with get,set

        [<DataMember(Name="Unit")>]
        member val Unit:String = null with get,set

        [<DataMember(Name="Mandatory")>]
        member val Mandatory:Boolean = new Boolean() with get,set

        [<DataMember(Name="Position")>]
        member val Position:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkAttributeNote() = 
        [<DataMember(Name="NoteId")>]
        member val NoteId:Int32 = new Int32() with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="ImageSlice")>]
        member val ImageSlice:Byte[] = [||] with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkAttribute() = 
        [<DataMember(Name="RadiatisId")>]
        member val RadiatisId:Int32 = new Int32() with get,set

        [<DataMember(Name="Code")>]
        member val Code:String = null with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Notes")>]
        member val Notes:IList<HkAttributeNote> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkLayout() = 
        [<DataMember(Name="Title")>]
        member val Title:String = null with get,set

        [<DataMember(Name="Comment")>]
        member val Comment:String = null with get,set

        [<DataMember(Name="Image")>]
        member val Image:Byte[] = [||] with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HkGroup() = 
        [<DataMember(Name="Id")>]
        member val Id:Int32 = new Int32() with get,set

        [<DataMember(Name="Number")>]
        member val Number:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Comment")>]
        member val Comment:String = null with get,set

        [<DataMember(Name="SectionId")>]
        member val SectionId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Name="Characteristic")>]
        member val Characteristic:String = null with get,set

        [<DataMember(Name="Parameters")>]
        member val Parameters:IList<HkParameter> = null with get,set

        [<DataMember(Name="Attributes")>]
        member val Attributes:IList<HkAttribute> = null with get,set

        [<DataMember(Name="Images")>]
        member val Images:IList<Byte[]> = null with get,set

        [<DataMember(Name="Layouts")>]
        member val Layouts:IList<HkLayout> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetHkReferenceDataResponse() = 
        [<DataMember(Name="LoadedAt")>]
        member val LoadedAt:DateTime = new DateTime() with get,set

        [<DataMember(Name="Sections")>]
        member val Sections:IList<HkSection> = null with get,set

        [<DataMember(Name="Groups")>]
        member val Groups:IList<HkGroup> = null with get,set

        [<DataMember(Name="ResponseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Eras2AppServiceModelBase() = 
        [<DataMember(Name="UserId")>]
        member val UserId:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetHkReferenceData() = 
        inherit Eras2AppServiceModelBase()

F# 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: calotec-portal-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
		}
	}
}