Server

<back to all web services

GetEras2FileList

Eras2Files
Requires Authentication
The following routes are available for this service:
GET/api/v1/eras2files
namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

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

    type Eras2FileType =
        | DSatz = 0
        | Hka = 1
        | E835Satz = 2
        | E898Satz = 3
        | Abrechnung = 4
        | ArgeSatz = 5
        | NutzerFile = 6
        | DevicePdf = 7

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

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

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

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

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

    [<AllowNullLiteral>]
    type GetEras2FileListResponse() = 
        member val Eras2FileList:IEnumerable<Eras2File> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetEras2FileList() = 
        [<ApiMember(IsRequired=true, ParameterType="query")>]
        member val BearerToken:String = null with get,set

        ///<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")>]
        member val FilterByFileType:String = null with get,set

        ///<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")>]
        member val FilterByName:String = null with get,set

F# GetEras2FileList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: mi-waerme-servdesk.eras-online.de 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}