Report Filing Service

DeleteFiles

DeleteFilesSync

Represents a request to delete ELMA response files and returns the deleted files in a zip file.

The following routes are available for this service:
POST	/sync/elma/files/delete

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents a request to delete ELMA response files and returns the deleted files in a zip file.
*/
@Api(Description="Represents a request to delete ELMA response files and returns the deleted files in a zip file.")
open class DeleteFiles : DeleteFilesBase()
{
}

/**
* Specifies a request to delete ELMA response files and returns the deleted files in a zip file.
*/
@Api(Description="Specifies a request to delete ELMA response files and returns the deleted files in a zip file.")
open class DeleteFilesBase : IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
{
    /**
    * The parameters to search or filter on the ELMA response files.
    */
    @ApiMember(Description="The parameters to search or filter on the ELMA response files.", IsRequired=true, Name="SearchCriteria")
    var searchCriteria:SearchCriteria? = null

    /**
    * The credential to gain access on the ELMA server.
    */
    @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
    var credential:ElmaCredential? = null

    /**
    * Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.
    */
    @ApiMember(Description="Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.", Name="StagingEnabled")
    var stagingEnabled:Boolean? = null
}

/**
* Represent parameters to search or filter on submissions. 
*/
@Api(Description="Represent parameters to search or filter on submissions. ")
open class SearchCriteria
{
    /**
    * Full or partial name of the item (report or protocol) to search.
    */
    @ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")
    var name:String? = null

    /**
    * TThe ELMA product designation.
    */
    @ApiMember(Description="TThe ELMA product designation.", Name="Designation")
    var designation:Verfahren? = null
}

enum class Verfahren
{
    Cc,
    Cs,
    Dc,
    Fc,
    Fs,
    Fa,
    Km,
}

/**
* Represents the credentials of a user to authenticate the access of an ELMA server.
*/
@Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
open class ElmaCredential : IElmaCredential
{
    /**
    * The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.
    */
    @ApiMember(Description="The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
    var id:String? = null

    /**
    * The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)
    */
    @ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate")
    @Required()
    @StringLength(2147483647)
    var certificate:PemCertificate? = null

    /**
    * The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
    */
    @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")
    @Required()
    @StringLength(11)
    var authSteuernummer:String? = null

    /**
    * The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
    */
    @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
    @Required()
    @StringLength(10)
    var accountId:String? = null

    /**
    * The password to protect the certificate from unauthorized access.
    */
    @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
    var password:String? = null
}

/**
* Represents a PEM-encoded certificate.
*/
@Api(Description="Represents a PEM-encoded certificate.")
open class PemCertificate
{
    /**
    * The unique identifier (e.g. the file name) of the certificate.
    */
    @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
    var id:String? = null

    /**
    * The PEM-encoded content of the certificate.
    */
    @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
    var content:String? = null

    /**
    * The description of the certificate.
    */
    @ApiMember(Description="The description of the certificate.", Name="Description")
    var description:String? = null

    /**
    * Tags to label or identify the certificate.
    */
    @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    var tags:ArrayList<String> = ArrayList<String>()
}

Kotlin DeleteFiles 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.

POST /sync/elma/files/delete HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DeleteFiles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
  <Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
    <d2p1:AccountId>String</d2p1:AccountId>
    <d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
    <d2p1:Certificate xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
      <d3p1:Content>String</d3p1:Content>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:Tags>
    </d2p1:Certificate>
    <d2p1:Password>String</d2p1:Password>
  </Credential>
  <SearchCriteria>
    <Designation>CC</Designation>
    <Name>String</Name>
  </SearchCriteria>
  <StagingEnabled>false</StagingEnabled>
</DeleteFiles>