Server

<back to all web services

GetEras2FileList

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

export enum Eras2FileType
{
    DSatz = 'DSatz',
    Hka = 'Hka',
    E835Satz = 'E835Satz',
    E898Satz = 'E898Satz',
    Abrechnung = 'Abrechnung',
    ArgeSatz = 'ArgeSatz',
    NutzerFile = 'NutzerFile',
    DevicePdf = 'DevicePdf',
}

// @DataContract
export class Eras2File
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="FileType")
    public FileType: Eras2FileType;

    // @DataMember(Name="ObjektGuid")
    public ObjektGuid?: string;

    // @DataMember(Name="NutzerGuid")
    public NutzerGuid?: string;

    public constructor(init?: Partial<Eras2File>) { (Object as any).assign(this, init); }
}

export class GetEras2FileListResponse
{
    public eras2FileList: Eras2File[];
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetEras2FileListResponse>) { (Object as any).assign(this, init); }
}

export class GetEras2FileList implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    /** @description Optional! Follow the format : /api/v1/eras2files?filter[FileType]=* */
    // @DataMember(Name="filter[FileType]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[FileType]=*", ParameterType="query")
    public filter_FileType_: string;

    /** @description Optional! Follow the format : /api/v1/eras2files?filter[Name]=* */
    // @DataMember(Name="filter[Name]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/eras2files?filter[Name]=*", ParameterType="query")
    public filter_Name_: string;

    public constructor(init?: Partial<GetEras2FileList>) { (Object as any).assign(this, init); }
}

TypeScript 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: brendle-schneider-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>