Report Filing Service
| POST | /sync/elma/protocols/retrieve |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Represents a request to retrieve protocols.
*/
@Api(Description="Represents a request to retrieve protocols.")
public static class RetrieveProtocols extends RetrieveProtocolsBase
{
}
/**
* Specifies a request to retrieve protocols.
*/
@Api(Description="Specifies a request to retrieve protocols.")
public static class RetrieveProtocolsBase implements IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
{
/**
* The parameters to search for protocols.
*/
@ApiMember(Description="The parameters to search for protocols.", IsRequired=true, Name="SearchCriteria")
public 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")
public ElmaCredential credential = 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")
public Boolean stagingEnabled = null;
public SearchCriteria getSearchCriteria() { return searchCriteria; }
public RetrieveProtocolsBase setSearchCriteria(SearchCriteria value) { this.searchCriteria = value; return this; }
public ElmaCredential getCredential() { return credential; }
public RetrieveProtocolsBase setCredential(ElmaCredential value) { this.credential = value; return this; }
public Boolean isStagingEnabled() { return stagingEnabled; }
public RetrieveProtocolsBase setStagingEnabled(Boolean value) { this.stagingEnabled = value; return this; }
}
/**
* Represent parameters to search or filter on submissions.
*/
@Api(Description="Represent parameters to search or filter on submissions. ")
public static 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")
public String name = null;
/**
* TThe ELMA product designation.
*/
@ApiMember(Description="TThe ELMA product designation.", Name="Designation")
public Verfahren designation = null;
public String getName() { return name; }
public SearchCriteria setName(String value) { this.name = value; return this; }
public Verfahren getDesignation() { return designation; }
public SearchCriteria setDesignation(Verfahren value) { this.designation = value; return this; }
}
public static enum 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.")
public static class ElmaCredential implements 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")
public String id = 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)
public PemCertificate certificate = 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)
public String authSteuernummer = 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)
public String accountId = 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")
public String password = null;
public String getId() { return id; }
public ElmaCredential setId(String value) { this.id = value; return this; }
public PemCertificate getCertificate() { return certificate; }
public ElmaCredential setCertificate(PemCertificate value) { this.certificate = value; return this; }
public String getAuthSteuernummer() { return authSteuernummer; }
public ElmaCredential setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
public String getAccountId() { return accountId; }
public ElmaCredential setAccountId(String value) { this.accountId = value; return this; }
public String getPassword() { return password; }
public ElmaCredential setPassword(String value) { this.password = value; return this; }
}
/**
* Represents a PEM-encoded certificate.
*/
@Api(Description="Represents a PEM-encoded certificate.")
public static 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")
public String id = null;
/**
* The PEM-encoded content of the certificate.
*/
@ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
public String content = null;
/**
* The description of the certificate.
*/
@ApiMember(Description="The description of the certificate.", Name="Description")
public String description = null;
/**
* Tags to label or identify the certificate.
*/
@ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
public ArrayList<String> tags = null;
public String getId() { return id; }
public PemCertificate setId(String value) { this.id = value; return this; }
public String getContent() { return content; }
public PemCertificate setContent(String value) { this.content = value; return this; }
public String getDescription() { return description; }
public PemCertificate setDescription(String value) { this.description = value; return this; }
public ArrayList<String> getTags() { return tags; }
public PemCertificate setTags(ArrayList<String> value) { this.tags = value; return this; }
}
/**
* Encapsulates the results of a protocol retrieval operation.
*/
@Api(Description="Encapsulates the results of a protocol retrieval operation.")
public static class RetrievalResponse
{
/**
* Processing logs that indicate the status of submitted reports.
*/
@ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols")
public ArrayList<Elma> protocols = null;
/**
* Other artefacts including the auxillary files from the BZSt.
*/
@ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files")
public ArrayList<BinaryFile> files = null;
/**
* The status of the response.
*/
@ApiMember(Description="The status of the response.", Name="ResponseStatus")
public ResponseStatus responseStatus = null;
public ArrayList<Elma> getProtocols() { return protocols; }
public RetrievalResponse setProtocols(ArrayList<Elma> value) { this.protocols = value; return this; }
public ArrayList<BinaryFile> getFiles() { return files; }
public RetrievalResponse setFiles(ArrayList<BinaryFile> value) { this.files = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public RetrievalResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Represents an ELMA report document.
*/
@Api(Description="Represents an ELMA report document.")
public static class Elma
{
/**
* 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 String id = null;
/**
* The location of the XML Schema to use for the root namespace.
*/
@ApiMember(Description="The location of the XML Schema to use for the root namespace.", Name="SchemaLocation")
public String schemaLocation = null;
/**
* The type of reporting process.
*/
@ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren")
public Verfahren verfahren = null;
/**
* The communication section of the ELMA report document.
*/
@ApiMember(Description="The communication section of the ELMA report document.", IsRequired=true, Name="ElmaKom")
public ElmaKom elmaKom = null;
/**
* The communication section of the ELMA report document.
*/
@ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll")
public ElmaProtokoll elmaProtokoll = null;
/**
* The communication section of the ELMA report document.
*/
@ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler")
public ElmaFehler elmaFehler = null;
public String getId() { return id; }
public Elma setId(String value) { this.id = value; return this; }
public String getSchemaLocation() { return schemaLocation; }
public Elma setSchemaLocation(String value) { this.schemaLocation = value; return this; }
public Verfahren getVerfahren() { return verfahren; }
public Elma setVerfahren(Verfahren value) { this.verfahren = value; return this; }
public ElmaKom getElmaKom() { return elmaKom; }
public Elma setElmaKom(ElmaKom value) { this.elmaKom = value; return this; }
public ElmaProtokoll getElmaProtokoll() { return elmaProtokoll; }
public Elma setElmaProtokoll(ElmaProtokoll value) { this.elmaProtokoll = value; return this; }
public ElmaFehler getElmaFehler() { return elmaFehler; }
public Elma setElmaFehler(ElmaFehler value) { this.elmaFehler = value; return this; }
}
/**
* Represents the communication section of an ELMA report document.
*/
@Api(Description="Represents the communication section of an ELMA report document.")
public static class ElmaKom
{
/**
* The version number of the ELMAKOM definition.
*/
@ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion")
public String elmakomVersion = null;
/**
* The header part of the ELMAKOM definition.
*/
@ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader")
public ElmaHeader elmaHeader = null;
/**
* The process part of the ELMAKOM definition.
*/
@ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren")
public ElmaVerfahren elmaVerfahren = null;
public String getElmakomVersion() { return elmakomVersion; }
public ElmaKom setElmakomVersion(String value) { this.elmakomVersion = value; return this; }
public ElmaHeader getElmaHeader() { return elmaHeader; }
public ElmaKom setElmaHeader(ElmaHeader value) { this.elmaHeader = value; return this; }
public ElmaVerfahren getElmaVerfahren() { return elmaVerfahren; }
public ElmaKom setElmaVerfahren(ElmaVerfahren value) { this.elmaVerfahren = value; return this; }
}
/**
* Represents the header of an ELMA communication section.
*/
@Api(Description="Represents the header of an ELMA communication section.")
public static class ElmaHeader
{
/**
* The process-specific report type of an ELMA document.It distinguishes by the type of input.
*/
@ApiMember(Description="The process-specific report type of an ELMA document.It distinguishes by the type of input.", IsRequired=true, Name="DatenArt")
public DatenArt datenArt = 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")
public String authSteuernummer = 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")
public String accountId = null;
/**
* The time of creation.Corresponds to the time, at which the user created a file.
*/
@ApiMember(Description="The time of creation.Corresponds to the time, at which the user created a file.", Name="ErstellungsDatum")
public Date erstellungsDatum = null;
/**
* User custom ID.This field can be filled with internal reference information of the user.
*/
@ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")
public String kundeneigeneId = null;
/**
* Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
*/
@ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")
public UUID uuid = null;
/**
* Distinguishes between test and live data transfer.
*/
@ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf")
public Verarbeitungslauf verarbeitungslauf = null;
public DatenArt getDatenArt() { return datenArt; }
public ElmaHeader setDatenArt(DatenArt value) { this.datenArt = value; return this; }
public String getAuthSteuernummer() { return authSteuernummer; }
public ElmaHeader setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
public String getAccountId() { return accountId; }
public ElmaHeader setAccountId(String value) { this.accountId = value; return this; }
public Date getErstellungsDatum() { return erstellungsDatum; }
public ElmaHeader setErstellungsDatum(Date value) { this.erstellungsDatum = value; return this; }
public String getKundeneigeneId() { return kundeneigeneId; }
public ElmaHeader setKundeneigeneId(String value) { this.kundeneigeneId = value; return this; }
public UUID getUuid() { return uuid; }
public ElmaHeader setUuid(UUID value) { this.uuid = value; return this; }
public Verarbeitungslauf getVerarbeitungslauf() { return verarbeitungslauf; }
public ElmaHeader setVerarbeitungslauf(Verarbeitungslauf value) { this.verarbeitungslauf = value; return this; }
}
public static enum DatenArt
{
ElmaCc,
ElmaCcrm,
ElmaCrs,
ElmaCrsrm,
ElmaDc,
ElmaDcrm,
ElmaFc,
ElmaFcrm;
}
public static enum Verarbeitungslauf
{
Produktionslauf,
Testlauf;
}
public static class ElmaVerfahren
{
/**
* The content of process-specific definition.
*/
@ApiMember(Description="The content of process-specific definition.", Name="Inhalt")
public Object inhalt = null;
public Object getInhalt() { return inhalt; }
public ElmaVerfahren setInhalt(Object value) { this.inhalt = value; return this; }
}
/**
* Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
*/
@Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")
public static class ElmaProtokoll
{
/**
* File name of the processed input ELMA report.
*/
@ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
public String dateiname = 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")
public String authSteuernummer = 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")
public String accountId = null;
/**
* Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
*/
@ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")
public Date verarbeitungsDatum = null;
/**
* Time of processing by ELAN (ELMA receiving server at BZSt).
*/
@ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")
public Date verarbeitungsZeit = null;
/**
* The status code of the ELMA process.
*/
@ApiMember(Description="The status code of the ELMA process.", Name="Status")
public Status status = null;
/**
* A brief description of the status.
*/
@ApiMember(Description="A brief description of the status.", Name="StatusText")
public String statusText = null;
/**
* A detailed information on the status.
*/
@ApiMember(Description="A detailed information on the status.", Name="StatusDetail")
public String statusDetail = null;
/**
* User custom ID.This field can be filled with internal reference information of the user.
*/
@ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")
public String kundeneigeneId = null;
/**
* Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
*/
@ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")
public UUID uuid = null;
public String getDateiname() { return dateiname; }
public ElmaProtokoll setDateiname(String value) { this.dateiname = value; return this; }
public String getAuthSteuernummer() { return authSteuernummer; }
public ElmaProtokoll setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
public String getAccountId() { return accountId; }
public ElmaProtokoll setAccountId(String value) { this.accountId = value; return this; }
public Date getVerarbeitungsDatum() { return verarbeitungsDatum; }
public ElmaProtokoll setVerarbeitungsDatum(Date value) { this.verarbeitungsDatum = value; return this; }
public Date getVerarbeitungsZeit() { return verarbeitungsZeit; }
public ElmaProtokoll setVerarbeitungsZeit(Date value) { this.verarbeitungsZeit = value; return this; }
public Status getStatus() { return status; }
public ElmaProtokoll setStatus(Status value) { this.status = value; return this; }
public String getStatusText() { return statusText; }
public ElmaProtokoll setStatusText(String value) { this.statusText = value; return this; }
public String getStatusDetail() { return statusDetail; }
public ElmaProtokoll setStatusDetail(String value) { this.statusDetail = value; return this; }
public String getKundeneigeneId() { return kundeneigeneId; }
public ElmaProtokoll setKundeneigeneId(String value) { this.kundeneigeneId = value; return this; }
public UUID getUuid() { return uuid; }
public ElmaProtokoll setUuid(UUID value) { this.uuid = value; return this; }
}
public static enum Status
{
ElmaGlobalUnbekannt(0),
ElmaOk(8000),
ElmaParserFehler(8001),
ElmaUngueltigeKodierung(8002),
ElmaUngueltigeDateiname(8003),
ElmaFalscheBzstnrOderAccountid(8004),
ElmaSignaturDateiFehlt(8005),
ElmaSignaturPruefungFehlerhaft(8006),
ElmaNotwendigeFachlicheBerechtigungenFehlen(8007),
ElmaFreischaltungFehlt(8008),
ElmaSperreVorhanden(8009),
ElmaDateinameBereitsVerwendet(8010),
ElmaDateiinhaltIdentisch(8011),
ElmaBzstnrOderAccountidStimmtNichtUberein(8012),
ElmaTestdaten(8013);
private final int value;
Status(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
/**
* Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.
*/
@Api(Description="Represents an ELMA protocol report, which the ELMA servers return after a formal verification of a submitted ELMA report.")
public static class ElmaFehler
{
/**
* File name of the processed input ELMA report.
*/
@ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
public String dateiname = 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")
public String authSteuernummer = 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")
public String accountId = null;
/**
* Date on which the request was processed by ELAN (ELMA receiving server at BZSt).
*/
@ApiMember(Description="Date on which the request was processed by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsDatum")
public Date verarbeitungsDatum = null;
/**
* Time of processing by ELAN (ELMA receiving server at BZSt).
*/
@ApiMember(Description="Time of processing by ELAN (ELMA receiving server at BZSt).", Name="VerarbeitungsZeit")
public Date verarbeitungsZeit = null;
/**
* The status code of the ELMA process.
*/
@ApiMember(Description="The status code of the ELMA process.", Name="FehlerID")
public Status fehlerID = null;
/**
* A brief description of the error status.
*/
@ApiMember(Description="A brief description of the error status.", Name="FehlerText")
public String fehlerText = null;
/**
* A detailed information on the status.
*/
@ApiMember(Description="A detailed information on the status.", Name="FehlerProzess")
public String fehlerProzess = null;
/**
* User custom ID.This field can be filled with internal reference information of the user.
*/
@ApiMember(Description="User custom ID.This field can be filled with internal reference information of the user.", Name="KundeneigeneId")
public String kundeneigeneId = null;
/**
* Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
*/
@ApiMember(Description="Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000", Name="UUID")
public UUID uuid = null;
public String getDateiname() { return dateiname; }
public ElmaFehler setDateiname(String value) { this.dateiname = value; return this; }
public String getAuthSteuernummer() { return authSteuernummer; }
public ElmaFehler setAuthSteuernummer(String value) { this.authSteuernummer = value; return this; }
public String getAccountId() { return accountId; }
public ElmaFehler setAccountId(String value) { this.accountId = value; return this; }
public Date getVerarbeitungsDatum() { return verarbeitungsDatum; }
public ElmaFehler setVerarbeitungsDatum(Date value) { this.verarbeitungsDatum = value; return this; }
public Date getVerarbeitungsZeit() { return verarbeitungsZeit; }
public ElmaFehler setVerarbeitungsZeit(Date value) { this.verarbeitungsZeit = value; return this; }
public Status getFehlerID() { return fehlerID; }
public ElmaFehler setFehlerID(Status value) { this.fehlerID = value; return this; }
public String getFehlerText() { return fehlerText; }
public ElmaFehler setFehlerText(String value) { this.fehlerText = value; return this; }
public String getFehlerProzess() { return fehlerProzess; }
public ElmaFehler setFehlerProzess(String value) { this.fehlerProzess = value; return this; }
public String getKundeneigeneId() { return kundeneigeneId; }
public ElmaFehler setKundeneigeneId(String value) { this.kundeneigeneId = value; return this; }
public UUID getUuid() { return uuid; }
public ElmaFehler setUuid(UUID value) { this.uuid = value; return this; }
}
/**
* Represents a file that contains raw data content in bytes
*/
@Api(Description="Represents a file that contains raw data content in bytes")
public static class BinaryFile extends FileBase
{
/**
* The attributes of the file.
*/
@ApiMember(Description="The attributes of the file.", Name="Metadata")
public FileMetadata metadata = null;
/**
* The name of the file without information on its directory path.
*/
@ApiMember(Description="The name of the file without information on its directory path.", Name="Name")
public String name = null;
public FileMetadata getMetadata() { return metadata; }
public BinaryFile setMetadata(FileMetadata value) { this.metadata = value; return this; }
public String getName() { return name; }
public BinaryFile setName(String value) { this.name = value; return this; }
}
/**
* Represents a base class for a file with raw data.
*/
@Api(Description="Represents a base class for a file with raw data.")
public static class FileBase
{
/**
* The raw data content of the file.
*/
@ApiMember(Description="The raw data content of the file.", Name="Content")
public byte[] content = null;
public byte[] getContent() { return content; }
public FileBase setContent(byte[] value) { this.content = value; return this; }
}
/**
* Represents information about a file or directory.
*/
@Api(Description="Represents information about a file or directory.")
public static class FileMetadata implements IFileMetadata
{
/**
* The name of the file.For files, gets the name of the file.For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.
*/
@ApiMember(Description="The name of the file.\nFor files, gets the name of the file.\nFor directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.", Name="Name")
public String name = null;
/**
* The full path of the directory or file.
*/
@ApiMember(Description="The full path of the directory or file.", Name="FullName")
public String fullName = null;
/**
* The time the current file or directory was last accessed.
*/
@ApiMember(Description="The time the current file or directory was last accessed.", Name="LastAccessTime")
public Date lastAccessTime = null;
/**
* The name of the file.
*/
@ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
public Date lastAccessTimeUtc = null;
/**
* The time when the current file or directory was last written to.
*/
@ApiMember(Description="The time when the current file or directory was last written to.", Name="LastAccessTime")
public Date lastWriteTime = null;
/**
* The time, in coordinated universal time (UTC), when the current file or directory was last written to.
*/
@ApiMember(Description="The time, in coordinated universal time (UTC), when the current file or directory was last written to.", Name="LastWriteTimeUtc")
public Date lastWriteTimeUtc = null;
/**
* The size, in bytes, of the current file.
*/
@ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
public Long length = null;
/**
* The size, in bytes, of the current file.
*/
@ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
public Integer userId = null;
/**
* The file group id.
*/
@ApiMember(Description="The file group id.", Name="GroupId")
public Integer groupId = null;
/**
* A value that indicates whether the others can read from this file.
*/
@ApiMember(Description="A value that indicates whether the others can read from this file.", Name="OthersCanRead")
public Boolean othersCanRead = null;
/**
* A value that indicates whether the group members can execute this file.
*/
@ApiMember(Description="A value that indicates whether the group members can execute this file.", Name="GroupCanExecute")
public Boolean groupCanExecute = null;
/**
* A value that indicates whether the group members can write into this file.
*/
@ApiMember(Description="A value that indicates whether the group members can write into this file.", Name="GroupCanWrite")
public Boolean groupCanWrite = null;
/**
* A value that indicates whether the group members can read from this file.
*/
@ApiMember(Description="A value that indicates whether the group members can read from this file.", Name="GroupCanRead")
public Boolean groupCanRead = null;
/**
* A value that indicates whether the owner can execute this file.
*/
@ApiMember(Description="A value that indicates whether the owner can execute this file.", Name="OwnerCanExecute")
public Boolean ownerCanExecute = null;
/**
* A value that indicates whether the owner can write into this file.
*/
@ApiMember(Description="A value that indicates whether the owner can write into this file.", Name="OwnerCanWrite")
public Boolean ownerCanWrite = null;
/**
* A value that indicates whether the owner can read from this file.
*/
@ApiMember(Description="A value that indicates whether the owner can read from this file.", Name="OthersCanRead")
public Boolean ownerCanRead = null;
/**
* A value that indicates whether others can read from this file.
*/
@ApiMember(Description="A value that indicates whether others can read from this file.", Name="OthersCanExecute")
public Boolean othersCanExecute = null;
/**
* A value that indicates whether others can write into this file.
*/
@ApiMember(Description="A value that indicates whether others can write into this file.", Name="OthersCanWrite")
public Boolean othersCanWrite = null;
/**
* Extensions to the file attributes.
*/
@ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
public HashMap<String,String> extensions = null;
public String getName() { return name; }
public FileMetadata setName(String value) { this.name = value; return this; }
public String getFullName() { return fullName; }
public FileMetadata setFullName(String value) { this.fullName = value; return this; }
public Date getLastAccessTime() { return lastAccessTime; }
public FileMetadata setLastAccessTime(Date value) { this.lastAccessTime = value; return this; }
public Date getLastAccessTimeUtc() { return lastAccessTimeUtc; }
public FileMetadata setLastAccessTimeUtc(Date value) { this.lastAccessTimeUtc = value; return this; }
public Date getLastWriteTime() { return lastWriteTime; }
public FileMetadata setLastWriteTime(Date value) { this.lastWriteTime = value; return this; }
public Date getLastWriteTimeUtc() { return lastWriteTimeUtc; }
public FileMetadata setLastWriteTimeUtc(Date value) { this.lastWriteTimeUtc = value; return this; }
public Long getLength() { return length; }
public FileMetadata setLength(Long value) { this.length = value; return this; }
public Integer getUserId() { return userId; }
public FileMetadata setUserId(Integer value) { this.userId = value; return this; }
public Integer getGroupId() { return groupId; }
public FileMetadata setGroupId(Integer value) { this.groupId = value; return this; }
public Boolean isOthersCanRead() { return othersCanRead; }
public FileMetadata setOthersCanRead(Boolean value) { this.othersCanRead = value; return this; }
public Boolean isGroupCanExecute() { return groupCanExecute; }
public FileMetadata setGroupCanExecute(Boolean value) { this.groupCanExecute = value; return this; }
public Boolean isGroupCanWrite() { return groupCanWrite; }
public FileMetadata setGroupCanWrite(Boolean value) { this.groupCanWrite = value; return this; }
public Boolean isGroupCanRead() { return groupCanRead; }
public FileMetadata setGroupCanRead(Boolean value) { this.groupCanRead = value; return this; }
public Boolean isOwnerCanExecute() { return ownerCanExecute; }
public FileMetadata setOwnerCanExecute(Boolean value) { this.ownerCanExecute = value; return this; }
public Boolean isOwnerCanWrite() { return ownerCanWrite; }
public FileMetadata setOwnerCanWrite(Boolean value) { this.ownerCanWrite = value; return this; }
public Boolean isOwnerCanRead() { return ownerCanRead; }
public FileMetadata setOwnerCanRead(Boolean value) { this.ownerCanRead = value; return this; }
public Boolean isOthersCanExecute() { return othersCanExecute; }
public FileMetadata setOthersCanExecute(Boolean value) { this.othersCanExecute = value; return this; }
public Boolean isOthersCanWrite() { return othersCanWrite; }
public FileMetadata setOthersCanWrite(Boolean value) { this.othersCanWrite = value; return this; }
public HashMap<String,String> getExtensions() { return extensions; }
public FileMetadata setExtensions(HashMap<String,String> value) { this.extensions = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/elma/protocols/retrieve HTTP/1.1
Host: reportfiling.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length
{"protocols":[{"id":"String","schemaLocation":"String","verfahren":"CC","elmaKom":{"elmakomVersion":"String","elmaHeader":{"datenArt":"ELMA_CC","authSteuernummer":"String","accountId":"String","erstellungsDatum":"\/Date(-62135596800000-0000)\/","kundeneigeneId":"String","uuid":"00000000000000000000000000000000","verarbeitungslauf":"PRODUKTIONSLAUF"},"elmaVerfahren":{"inhalt":{}}},"elmaProtokoll":{"dateiname":"String","authSteuernummer":"String","accountId":"String","verarbeitungsDatum":"\/Date(-62135596800000-0000)\/","verarbeitungsZeit":"\/Date(-62135596800000-0000)\/","status":"ELMA_GLOBAL_UNBEKANNT","statusText":"String","statusDetail":"String","kundeneigeneId":"String","uuid":"00000000000000000000000000000000"},"elmaFehler":{"dateiname":"String","authSteuernummer":"String","accountId":"String","verarbeitungsDatum":"\/Date(-62135596800000-0000)\/","verarbeitungsZeit":"\/Date(-62135596800000-0000)\/","fehlerID":"ELMA_GLOBAL_UNBEKANNT","fehlerText":"String","fehlerProzess":"String","kundeneigeneId":"String","uuid":"00000000000000000000000000000000"}}],"files":[{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}