Report Filing Service

<back to all web services

RetrieveProtocolsAsync

RetrieveAsync

Represents a request to retrieve protocols in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
POST/async/elma/protocols/retrieve

export enum Verfahren
{
    CC = 'CC',
    CS = 'CS',
    DC = 'DC',
    FC = 'FC',
    FS = 'FS',
    FA = 'FA',
    KM = 'KM',
}

/** @description Represent parameters to search or filter on submissions.  */
// @Api(Description="Represent parameters to search or filter on submissions. ")
export class SearchCriteria
{
    /** @description 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 name: string;

    /** @description TThe ELMA product designation. */
    // @ApiMember(Description="TThe ELMA product designation.", Name="Designation")
    public designation?: Verfahren;

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

/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
export class PemCertificate
{
    /** @description 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 id: string;

    /** @description The PEM-encoded content of the certificate. */
    // @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
    public content: string;

    /** @description The description of the certificate. */
    // @ApiMember(Description="The description of the certificate.", Name="Description")
    public description: string;

    /** @description Tags to label or identify the certificate. */
    // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    public tags: string[];

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

/** @description 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.")
export class ElmaCredential implements IElmaCredential
{
    /** @description 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 id: string;

    /** @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) */
    // @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 certificate: PemCertificate;

    /** @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" */
    // @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 authSteuernummer: string;

    /** @description 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 accountId: string;

    /** @description 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 password: string;

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

/** @description Specifies a request to retrieve protocols. */
// @Api(Description="Specifies a request to retrieve protocols.")
export class RetrieveProtocolsBase implements IPost, IAuthenticateRequest, IStageableRequest, ISearchRequest
{
    /** @description The parameters to search for protocols. */
    // @ApiMember(Description="The parameters to search for protocols.", IsRequired=true, Name="SearchCriteria")
    public searchCriteria: SearchCriteria;

    /** @description 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 credential: ElmaCredential;

    /** @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. */
    // @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 stagingEnabled?: boolean;

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

export enum DatenArt
{
    ELMA_CC = 'ELMA_CC',
    ELMA_CCRM = 'ELMA_CCRM',
    ELMA_CRS = 'ELMA_CRS',
    ELMA_CRSRM = 'ELMA_CRSRM',
    ELMA_DC = 'ELMA_DC',
    ELMA_DCRM = 'ELMA_DCRM',
    ELMA_FC = 'ELMA_FC',
    ELMA_FCRM = 'ELMA_FCRM',
}

export enum Verarbeitungslauf
{
    PRODUKTIONSLAUF = 'PRODUKTIONSLAUF',
    TESTLAUF = 'TESTLAUF',
}

/** @description Represents the header of an ELMA communication section. */
// @Api(Description="Represents the header of an ELMA communication section.")
export class ElmaHeader
{
    /** @description 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;

    /** @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" */
    // @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 authSteuernummer: string;

    /** @description 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 accountId: string;

    /** @description 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 erstellungsDatum?: string;

    /** @description 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 kundeneigeneId: string;

    /** @description 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?: string;

    /** @description Distinguishes between test and live data transfer. */
    // @ApiMember(Description="Distinguishes between test and live data transfer.", Name="Verarbeitungslauf")
    public verarbeitungslauf: Verarbeitungslauf;

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

export class ElmaVerfahren
{
    /** @description The content of process-specific definition. */
    // @ApiMember(Description="The content of process-specific definition.", Name="Inhalt")
    public inhalt: Object;

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

/** @description Represents the communication section of an ELMA report document. */
// @Api(Description="Represents the communication section of an ELMA report document.")
export class ElmaKom
{
    /** @description The version number of the ELMAKOM definition. */
    // @ApiMember(Description="The version number of the ELMAKOM definition.", IsRequired=true, Name="ElmakomVersion")
    public elmakomVersion: string;

    /** @description The header part of the ELMAKOM definition. */
    // @ApiMember(Description="The header part of the ELMAKOM definition.", IsRequired=true, Name="ElmaHeader")
    public elmaHeader: ElmaHeader;

    /** @description The process part of the ELMAKOM definition. */
    // @ApiMember(Description="The process part of the ELMAKOM definition.", IsRequired=true, Name="ElmaVerfahren")
    public elmaVerfahren: ElmaVerfahren;

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

export enum Status
{
    ELMA_GLOBAL_UNBEKANNT = 0,
    ELMA_OK = 8000,
    ELMA_PARSER_FEHLER = 8001,
    ELMA_UNGUELTIGE_KODIERUNG = 8002,
    ELMA_UNGUELTIGE_DATEINAME = 8003,
    ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID = 8004,
    ELMA_SIGNATUR_DATEI_FEHLT = 8005,
    ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT = 8006,
    ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN = 8007,
    ELMA_FREISCHALTUNG_FEHLT = 8008,
    ELMA_SPERRE_VORHANDEN = 8009,
    ELMA_DATEINAME_BEREITS_VERWENDET = 8010,
    ELMA_DATEIINHALT_IDENTISCH = 8011,
    ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN = 8012,
    ELMA_TESTDATEN = 8013,
}

/** @description 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.")
export class ElmaProtokoll
{
    /** @description File name of the processed input ELMA report. */
    // @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
    public dateiname: string;

    /** @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" */
    // @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 authSteuernummer: string;

    /** @description 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 accountId: string;

    /** @description 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 verarbeitungsDatum?: string;

    /** @description 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 verarbeitungsZeit?: string;

    /** @description The status code of the ELMA process. */
    // @ApiMember(Description="The status code of the ELMA process.", Name="Status")
    public status: Status;

    /** @description A brief description of the status. */
    // @ApiMember(Description="A brief description of the status.", Name="StatusText")
    public statusText: string;

    /** @description A detailed information on the status. */
    // @ApiMember(Description="A detailed information on the status.", Name="StatusDetail")
    public statusDetail: string;

    /** @description 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 kundeneigeneId: string;

    /** @description 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?: string;

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

/** @description 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.")
export class ElmaFehler
{
    /** @description File name of the processed input ELMA report. */
    // @ApiMember(Description="File name of the processed input ELMA report.", Name="Dateiname")
    public dateiname: string;

    /** @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" */
    // @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 authSteuernummer: string;

    /** @description 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 accountId: string;

    /** @description 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 verarbeitungsDatum?: string;

    /** @description 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 verarbeitungsZeit?: string;

    /** @description The status code of the ELMA process. */
    // @ApiMember(Description="The status code of the ELMA process.", Name="FehlerID")
    public fehlerID: Status;

    /** @description A brief description of the error status. */
    // @ApiMember(Description="A brief description of the error status.", Name="FehlerText")
    public fehlerText: string;

    /** @description A detailed information on the status. */
    // @ApiMember(Description="A detailed information on the status.", Name="FehlerProzess")
    public fehlerProzess: string;

    /** @description 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 kundeneigeneId: string;

    /** @description 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?: string;

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

/** @description Represents an ELMA report document. */
// @Api(Description="Represents an ELMA report document.")
export class Elma
{
    /** @description 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 id: string;

    /** @description 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 schemaLocation: string;

    /** @description The type of reporting process. */
    // @ApiMember(Description="The type of reporting process.", IsRequired=true, Name="Verfahren")
    public verfahren: Verfahren;

    /** @description 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;

    /** @description The communication section of the ELMA report document. */
    // @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaProtokoll")
    public elmaProtokoll: ElmaProtokoll;

    /** @description The communication section of the ELMA report document. */
    // @ApiMember(Description="The communication section of the ELMA report document.", Name="ElmaFehler")
    public elmaFehler: ElmaFehler;

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

/** @description Represents a base class for a file with raw data. */
// @Api(Description="Represents a base class for a file with raw data.")
export class FileBase
{
    /** @description The raw data content of the file. */
    // @ApiMember(Description="The raw data content of the file.", Name="Content")
    public content: string;

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

/** @description Represents information about a file or directory. */
// @Api(Description="Represents information about a file or directory.")
export class FileMetadata implements IFileMetadata
{
    /** @description 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 name: string;

    /** @description The full path of the directory or file. */
    // @ApiMember(Description="The full path of the directory or file.", Name="FullName")
    public fullName: string;

    /** @description 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 lastAccessTime: string;

    /** @description The name of the file. */
    // @ApiMember(Description="The name of the file.", Name="LastAccessTimeUtc")
    public lastAccessTimeUtc: string;

    /** @description 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 lastWriteTime: string;

    /** @description 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 lastWriteTimeUtc: string;

    /** @description The size, in bytes, of the current file. */
    // @ApiMember(Description="The size, in bytes, of the current file.", Name="Length")
    public length: number;

    /** @description The size, in bytes, of the current file. */
    // @ApiMember(Description="The size, in bytes, of the current file.", Name="UserId")
    public userId: number;

    /** @description The file group id. */
    // @ApiMember(Description="The file group id.", Name="GroupId")
    public groupId: number;

    /** @description 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 othersCanRead: boolean;

    /** @description 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 groupCanExecute: boolean;

    /** @description 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 groupCanWrite: boolean;

    /** @description 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 groupCanRead: boolean;

    /** @description 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 ownerCanExecute: boolean;

    /** @description 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 ownerCanWrite: boolean;

    /** @description 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 ownerCanRead: boolean;

    /** @description 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 othersCanExecute: boolean;

    /** @description 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 othersCanWrite: boolean;

    /** @description Extensions to the file attributes. */
    // @ApiMember(Description="Extensions to the file attributes.", Name="Extensions")
    public extensions: { [index: string]: string; };

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

/** @description Represents a file that contains raw data content in bytes */
// @Api(Description="Represents a file that contains raw data content in bytes")
export class BinaryFile extends FileBase
{
    /** @description The attributes of the file. */
    // @ApiMember(Description="The attributes of the file.", Name="Metadata")
    public metadata: FileMetadata;

    /** @description 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 name: string;

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

/** @description Encapsulates the results of a protocol retrieval operation. */
// @Api(Description="Encapsulates the results of a protocol retrieval operation.")
export class RetrievalResponse
{
    /** @description Processing logs that indicate the status of submitted reports. */
    // @ApiMember(Description="Processing logs that indicate the status of submitted reports.", Name="Protocols")
    public protocols: Elma[];

    /** @description Other artefacts including the auxillary files from the BZSt. */
    // @ApiMember(Description="Other artefacts including the auxillary files from the BZSt.", Name="Files")
    public files: BinaryFile[];

    /** @description The status of the response. */
    // @ApiMember(Description="The status of the response.", Name="ResponseStatus")
    public responseStatus: ResponseStatus;

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

/** @description Represents a request to retrieve protocols in an asynchronous operation. */
// @Api(Description="Represents a request to retrieve protocols in an asynchronous operation.")
export class RetrieveProtocolsAsync extends RetrieveProtocolsBase
{

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

TypeScript RetrieveProtocolsAsync 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/protocols/retrieve HTTP/1.1 
Host: reportfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RetrieveProtocolsAsync 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>
</RetrieveProtocolsAsync>

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

<RetrievalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Concretes.Models">
    <d2p1:BinaryFile>
      <Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
      <d2p1:Metadata xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Concretes.Models">
        <d4p1:Extensions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Extensions>
        <d4p1:FullName>String</d4p1:FullName>
        <d4p1:GroupCanExecute>false</d4p1:GroupCanExecute>
        <d4p1:GroupCanRead>false</d4p1:GroupCanRead>
        <d4p1:GroupCanWrite>false</d4p1:GroupCanWrite>
        <d4p1:GroupId>0</d4p1:GroupId>
        <d4p1:LastAccessTime>0001-01-01T00:00:00</d4p1:LastAccessTime>
        <d4p1:LastAccessTimeUtc>0001-01-01T00:00:00</d4p1:LastAccessTimeUtc>
        <d4p1:LastWriteTime>0001-01-01T00:00:00</d4p1:LastWriteTime>
        <d4p1:LastWriteTimeUtc>0001-01-01T00:00:00</d4p1:LastWriteTimeUtc>
        <d4p1:Length>0</d4p1:Length>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:OthersCanExecute>false</d4p1:OthersCanExecute>
        <d4p1:OthersCanRead>false</d4p1:OthersCanRead>
        <d4p1:OthersCanWrite>false</d4p1:OthersCanWrite>
        <d4p1:OwnerCanExecute>false</d4p1:OwnerCanExecute>
        <d4p1:OwnerCanRead>false</d4p1:OwnerCanRead>
        <d4p1:OwnerCanWrite>false</d4p1:OwnerCanWrite>
        <d4p1:UserId>0</d4p1:UserId>
      </d2p1:Metadata>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:BinaryFile>
  </Files>
  <Protocols xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
    <d2p1:Elma xmlns:n1="http://www.itzbund.de/ELAN/01">
      <n1:ELMAKOM ELMAKOMVersion="String">
        <n1:ELMAHeader>
          <n1:DatenArt>ELMA_CC</n1:DatenArt>
          <n1:AuthSteuernummer>String</n1:AuthSteuernummer>
          <n1:AccountID>String</n1:AccountID>
          <n1:ErstellungsDatum>0001-01-01T00:00:00.000</n1:ErstellungsDatum>
          <n1:KundeneigeneID>String</n1:KundeneigeneID>
          <n1:UUID>00000000-0000-0000-0000-000000000000</n1:UUID>
          <n1:Verarbeitungslauf>PRODUKTIONSLAUF</n1:Verarbeitungslauf>
        </n1:ELMAHeader>
        <n1:ELMAVerfahren />
      </n1:ELMAKOM>
      <n1:ELMAProtokoll>
        <n1:Dateiname>String</n1:Dateiname>
        <n1:AuthSteuernummer>String</n1:AuthSteuernummer>
        <n1:AccountID>String</n1:AccountID>
        <n1:VerarbeitungsDatum>0001-01-01</n1:VerarbeitungsDatum>
        <n1:VerarbeitungsZeit>0001-01-01</n1:VerarbeitungsZeit>
        <n1:Status>ELMA_GLOBAL_UNBEKANNT</n1:Status>
        <n1:StatusText>String</n1:StatusText>
        <n1:StatusDetail>String</n1:StatusDetail>
        <n1:KundeneigeneID>String</n1:KundeneigeneID>
        <n1:UUID>00000000-0000-0000-0000-000000000000</n1:UUID>
      </n1:ELMAProtokoll>
      <n1:ELMAFEHLER>
        <n1:Dateiname>String</n1:Dateiname>
        <n1:AuthSteuernummer>String</n1:AuthSteuernummer>
        <n1:AccountID>String</n1:AccountID>
        <n1:VerarbeitungsDatum>0001-01-01</n1:VerarbeitungsDatum>
        <n1:VerarbeitungsZeit>00:00:00.000</n1:VerarbeitungsZeit>
        <n1:FehlerID>ELMA_GLOBAL_UNBEKANNT</n1:FehlerID>
        <n1:FehlerText>String</n1:FehlerText>
        <n1:FehlerProzess>String</n1:FehlerProzess>
        <n1:KundeneigeneID>String</n1:KundeneigeneID>
        <n1:UUID>00000000-0000-0000-0000-000000000000</n1:UUID>
      </n1:ELMAFEHLER>
    </d2p1:Elma>
  </Protocols>
  <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>
</RetrievalResponse>
© 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.