Report Filing Service
| POST | /sync/elma/reports/batch/recall |
|---|
import Foundation
import ServiceStack
/**
* Represents a request to recall reports from the ELMA server before it is processed.
*/
// @Api(Description="Represents a request to recall reports from the ELMA server before it is processed.")
public class BatchRecallReports : BatchRecallReportsBase
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
/**
* Specifies a request to recall reports from the ELMA server before it is processed.
*/
// @Api(Description="Specifies a request to recall reports from the ELMA server before it is processed.")
public class BatchRecallReportsBase : IPost, IAuthenticateRequest, IStageableRequest, Codable
{
/**
* The parameters to search or filter on reports.
*/
// @ApiMember(Description="The parameters to search or filter on reports.", IsRequired=true, Name="SearchCriteria")
public var searchCriteria:SearchCriteria
/**
* The credential to gain access on the ELMA server.
*/
// @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
public var credential:ElmaCredential
/**
* 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")
public var stagingEnabled:Bool?
required public init(){}
}
/**
* Represent parameters to search or filter on submissions.
*/
// @Api(Description="Represent parameters to search or filter on submissions. ")
public class SearchCriteria : Codable
{
/**
* 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")
public var name:String
/**
* TThe ELMA product designation.
*/
// @ApiMember(Description="TThe ELMA product designation.", Name="Designation")
public var designation:Verfahren?
required public init(){}
}
public enum Verfahren : String, Codable
{
case CC
case CS
case DC
case FC
case FS
case FA
case 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.")
public class ElmaCredential : IElmaCredential, Codable
{
/**
* 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")
public var id:String
/**
* 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(Int32.max)
public var certificate:PemCertificate?
/**
* 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)
public var authSteuernummer:String?
/**
* 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)
public var accountId:String?
/**
* The password to protect the certificate from unauthorized access.
*/
// @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
public var password:String
required public init(){}
}
/**
* Represents a PEM-encoded certificate.
*/
// @Api(Description="Represents a PEM-encoded certificate.")
public class PemCertificate : Codable
{
/**
* 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")
public var id:String
/**
* The PEM-encoded content of the certificate.
*/
// @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
public var content:String
/**
* The description of the certificate.
*/
// @ApiMember(Description="The description of the certificate.", Name="Description")
public var Description:String
/**
* Tags to label or identify the certificate.
*/
// @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
public var tags:[String] = []
required public init(){}
}
/**
* Encapsulates the results of a report recall operation.
*/
// @Api(Description="Encapsulates the results of a report recall operation.")
public class RecallResponse : Codable
{
/**
* The recalled reports.
*/
// @ApiMember(Description="The recalled reports.", Name="Reports")
public var reports:[Report] = []
/**
* The status of the recall operation.
*/
// @ApiMember(Description="The status of the recall operation.", Name="ResponseStatus")
public var responseStatus:ResponseStatus
required public init(){}
}
/**
* Represents an ELMA report.
*/
// @Api(Description="Represents an ELMA report.")
public class Report : Codable
{
/**
* The conventional ELMA file name of the report. The format of the ELMA formula is as follows: m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml where: m5 is a constant for all reporting types. pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc. BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789 AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890 DateiId is the 1 - 12 character internal short name for the data file.
*/
// @ApiMember(Description="The conventional ELMA file name of the report. The format of the ELMA formula is as follows: m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml where: m5 is a constant for all reporting types. pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc. BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789 AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890 DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
public var id:String
/**
* The XML-content of the report.
*/
// @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
public var data:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/elma/reports/batch/recall HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/json
Content-Type: application/json
Content-Length: length
{"searchCriteria":{"name":"String","designation":"CC"},"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"stagingEnabled":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"reports":[{"id":"String","data":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}