Server

GetEras2FileList

Eras2Files

The following routes are available for this service:
GET	/api/v1/eras2files

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 GetEras2FileList
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            '''<Summary>
            '''Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*
            '''</Summary>
            <DataMember(Name:="filter[FileType]")>
            <ApiMember(Description:="Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*", ParameterType:="query")>
            Public Overridable Property FilterByFileType As String

            '''<Summary>
            '''Optional! Follow the format : /api/v1/eras2files?filter[Name]=*
            '''</Summary>
            <DataMember(Name:="filter[Name]")>
            <ApiMember(Description:="Optional! Follow the format : /api/v1/eras2files?filter[Name]=*", ParameterType:="query")>
            Public Overridable Property FilterByName As String
        End Class

        Public Partial Class GetEras2FileListResponse
            Public Overridable Property Eras2FileList As IEnumerable(Of 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 GetEras2FileList DTOs

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 /api/v1/eras2files HTTP/1.1 
Host: korrekt-gera-servdesk.eras-online.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEras2FileListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <Eras2FileList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <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>
</GetEras2FileListResponse>