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.*;

public class dtos
{

    public static class GetEras2FileList implements IHasBearerToken
    {
        @ApiMember(IsRequired=true, ParameterType="query")
        public String bearerToken = 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")
        public String filterByFileType = 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")
        public String filterByName = null;
        
        public String getBearerToken() { return bearerToken; }
        public GetEras2FileList setBearerToken(String value) { this.bearerToken = value; return this; }
        public String getFilterByFileType() { return filterByFileType; }
        public GetEras2FileList setFilterByFileType(String value) { this.filterByFileType = value; return this; }
        public String getFilterByName() { return filterByName; }
        public GetEras2FileList setFilterByName(String value) { this.filterByName = value; return this; }
    }

    public static class GetEras2FileListResponse
    {
        public ArrayList<Eras2File> eras2FileList = null;
        public ResponseStatus responseStatus = null;
        
        public ArrayList<Eras2File> getEras2FileList() { return eras2FileList; }
        public GetEras2FileListResponse setEras2FileList(ArrayList<Eras2File> value) { this.eras2FileList = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetEras2FileListResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class Eras2File
    {
        @DataMember(Name="Guid")
        @SerializedName("Guid")
        public UUID guid = null;

        @DataMember(Name="Name")
        @SerializedName("Name")
        public String name = null;

        @DataMember(Name="FileType")
        @SerializedName("FileType")
        public Eras2FileType fileType = null;

        @DataMember(Name="ObjektGuid")
        @SerializedName("ObjektGuid")
        public UUID objektGuid = null;

        @DataMember(Name="NutzerGuid")
        @SerializedName("NutzerGuid")
        public UUID nutzerGuid = null;
        
        public UUID getGuid() { return guid; }
        public Eras2File setGuid(UUID value) { this.guid = value; return this; }
        public String getName() { return name; }
        public Eras2File setName(String value) { this.name = value; return this; }
        public Eras2FileType getFileType() { return fileType; }
        public Eras2File setFileType(Eras2FileType value) { this.fileType = value; return this; }
        public UUID getObjektGuid() { return objektGuid; }
        public Eras2File setObjektGuid(UUID value) { this.objektGuid = value; return this; }
        public UUID getNutzerGuid() { return nutzerGuid; }
        public Eras2File setNutzerGuid(UUID value) { this.nutzerGuid = value; return this; }
    }

    public static enum Eras2FileType
    {
        DSatz,
        Hka,
        E835Satz,
        E898Satz,
        Abrechnung,
        ArgeSatz,
        NutzerFile,
        DevicePdf;
    }

}

Java 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: knabrechnung-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>