Report Filing Service

<back to all web services

BatchDeleteFilesAsync

DeleteFilesBatchAsync

Represents a request to delete protocol files by using multiple search criteria in an asynchronous operation and return the deleted files in a zip file.

Requires Authentication
The following routes are available for this service:
POST/async/elma/files/batch/delete
namespace PwC.Elmaas.Core.Domain.Concretes.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type Verfahren =
        | CC = 0
        | CS = 1
        | DC = 2
        | FC = 3
        | FS = 4
        | FA = 5
        | KM = 6

    ///<summary>
    ///Represent parameters to search or filter on submissions. 
    ///</summary>
    [<Api(Description="Represent parameters to search or filter on submissions. ")>]
    [<AllowNullLiteral>]
    type SearchCriteria() = 
        ///<summary>
        ///Full or partial name of the item (report or protocol) to search.
        ///</summary>
        [<ApiMember(Description="Full or partial name of the item (report or protocol) to search.", Name="Name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///TThe ELMA product designation.
        ///</summary>
        [<ApiMember(Description="TThe ELMA product designation.", Name="Designation")>]
        member val Designation:Nullable<Verfahren> = new Nullable<Verfahren>() with get,set

    ///<summary>
    ///Represents a PEM-encoded certificate.
    ///</summary>
    [<Api(Description="Represents a PEM-encoded certificate.")>]
    [<AllowNullLiteral>]
    type PemCertificate() = 
        ///<summary>
        ///The unique identifier (e.g. the file name) of the certificate.
        ///</summary>
        [<ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The PEM-encoded content of the certificate.
        ///</summary>
        [<ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")>]
        member val Content:String = null with get,set

        ///<summary>
        ///The description of the certificate.
        ///</summary>
        [<ApiMember(Description="The description of the certificate.", Name="Description")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Tags to label or identify the certificate.
        ///</summary>
        [<ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")>]
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set

    ///<summary>
    ///Represents the credentials of a user to authenticate the access of an ELMA server.
    ///</summary>
    [<Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")>]
    [<AllowNullLiteral>]
    type ElmaCredential() = 
        ///<summary>
        ///The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.
        ///</summary>
        [<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")>]
        member val Id:String = null with get,set

        ///<summary>
        ///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)
        ///</summary>
        [<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(Int32.MaxValue)>]
        member val Certificate:PemCertificate = null with get,set

        ///<summary>
        ///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"
        ///</summary>
        [<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)>]
        member val AuthSteuernummer:String = null with get,set

        ///<summary>
        ///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
        ///</summary>
        [<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)>]
        member val AccountId:String = null with get,set

        ///<summary>
        ///The password to protect the certificate from unauthorized access.
        ///</summary>
        [<ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")>]
        member val Password:String = null with get,set

    ///<summary>
    ///Specifies a request to delete protocol files by using multiple search criteria and return the deleted files in a zip file.
    ///</summary>
    [<Api(Description="Specifies a request to delete protocol files by using multiple search criteria and return the deleted files in a zip file.")>]
    [<AllowNullLiteral>]
    type BatchDeleteFilesBase() = 
        interface IPost
        ///<summary>
        ///The parameters to search or filter the found protocols.
        ///</summary>
        [<ApiMember(Description="The parameters to search or filter the found protocols.", IsRequired=true, Name="SearchCriteria")>]
        member val SearchCriteria:ResizeArray<SearchCriteria> = new ResizeArray<SearchCriteria>() with get,set

        ///<summary>
        ///The credential to gain access on the ELMA server.
        ///</summary>
        [<ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")>]
        member val Credential:ElmaCredential = null with get,set

        ///<summary>
        ///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.
        ///</summary>
        [<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")>]
        member val StagingEnabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    ///<summary>
    ///Represents a request to delete protocol files by using multiple search criteria in an asynchronous operation and return the deleted files in a zip file.
    ///</summary>
    [<Api(Description="Represents a request to delete protocol files by using multiple search criteria in an asynchronous operation and return the deleted files in a zip file.")>]
    [<AllowNullLiteral>]
    type BatchDeleteFilesAsync() = 
        inherit BatchDeleteFilesBase()

F# BatchDeleteFilesAsync 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 /async/elma/files/batch/delete HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchDeleteFilesAsync 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>
    <SearchCriteria>
      <Designation>CC</Designation>
      <Name>String</Name>
    </SearchCriteria>
  </SearchCriteria>
  <StagingEnabled>false</StagingEnabled>
</BatchDeleteFilesAsync>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
© 2020 - 2023 PricewaterhouseCoopers GmbH Wirtschaftsprüfungsgesellschaft.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Portions of this program may use third-party open source components governed by the respective open source license terms.