Server

<back to all web services

GetEras2File

Eras2Files
Requires Authentication
The following routes are available for this service:
GET/api/v1/eras2files/{Guid}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Enums

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

        Public Enum Eras2FileType
            DSatz
            Hka
            E835Satz
            E898Satz
            Abrechnung
            ArgeSatz
            NutzerFile
            DevicePdf
        End Enum
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetEras2File
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            <ApiMember(IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Guid As Guid
        End Class

        Public Partial Class GetEras2FileResponse
            Public Overridable Property Eras2File As Eras2File
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models

        <DataContract>
        Public Partial Class Eras2File
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="Name")>
            Public Overridable Property Name As String

            <DataMember(Name:="FileType")>
            Public Overridable Property FileType As Eras2FileType

            <DataMember(Name:="ObjektGuid")>
            Public Overridable Property ObjektGuid As Nullable(Of Guid)

            <DataMember(Name:="NutzerGuid")>
            Public Overridable Property NutzerGuid As Nullable(Of Guid)
        End Class
    End Namespace
End Namespace

VB.NET GetEras2File 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 /api/v1/eras2files/{Guid} HTTP/1.1 
Host: messdienstservice-stadtwerke-peine-servdesk.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	eras2File: 
	{
		Guid: 00000000000000000000000000000000,
		Name: String,
		FileType: DSatz,
		ObjektGuid: 00000000000000000000000000000000,
		NutzerGuid: 00000000000000000000000000000000
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}