Server

<back to all web services

GetEras2FileList

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

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums
{
    public enum Eras2FileType
    {
        DSatz,
        Hka,
        E835Satz,
        E898Satz,
        Abrechnung,
        ArgeSatz,
        NutzerFile,
        DevicePdf,
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
{
    public partial class GetEras2FileList
        : IHasBearerToken
    {
        [ApiMember(IsRequired=true, ParameterType="query")]
        public virtual string BearerToken { 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")]
        public virtual string FilterByFileType { 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")]
        public virtual string FilterByName { get; set; }
    }

    public partial class GetEras2FileListResponse
    {
        public virtual IEnumerable<Eras2File> Eras2FileList { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
{
    [DataContract]
    public partial class Eras2File
    {
        [DataMember(Name="Guid")]
        public virtual Guid Guid { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="FileType")]
        public virtual Eras2FileType FileType { get; set; }

        [DataMember(Name="ObjektGuid")]
        public virtual Guid? ObjektGuid { get; set; }

        [DataMember(Name="NutzerGuid")]
        public virtual Guid? NutzerGuid { get; set; }
    }

}

C# GetEras2FileList 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 HTTP/1.1 
Host: korrekt-gera-servdesk.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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