Server

<back to all web services

GetEras2FileList

Eras2Files
Requires Authentication
The following routes are available for this service:
GET/api/v1/eras2files
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetEras2FileList : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null

    /**
    * Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*
    */
    @DataMember(Name="filter[FileType]")
    @SerializedName("filter[FileType]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*", ParameterType="query")
    var filterByFileType:String? = null

    /**
    * Optional! Follow the format : /api/v1/eras2files?filter[Name]=*
    */
    @DataMember(Name="filter[Name]")
    @SerializedName("filter[Name]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[Name]=*", ParameterType="query")
    var filterByName:String? = null
}

open class GetEras2FileListResponse
{
    var eras2FileList:ArrayList<Eras2File> = ArrayList<Eras2File>()
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class Eras2File
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:UUID? = null

    @DataMember(Name="Name")
    @SerializedName("Name")
    var name:String? = null

    @DataMember(Name="FileType")
    @SerializedName("FileType")
    var fileType:Eras2FileType? = null

    @DataMember(Name="ObjektGuid")
    @SerializedName("ObjektGuid")
    var objektGuid:UUID? = null

    @DataMember(Name="NutzerGuid")
    @SerializedName("NutzerGuid")
    var nutzerGuid:UUID? = null
}

enum class Eras2FileType
{
    DSatz,
    Hka,
    E835Satz,
    E898Satz,
    Abrechnung,
    ArgeSatz,
    NutzerFile,
    DevicePdf,
}

Kotlin 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: knabrechnung-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
		}
	}
}