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
System.NotSupportedException: Unknown language 'mjs', Supported languages: csharp, typescript, dart, java, kotlin, python, swift, vbnet, fsharp
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/ILangGenerator.cs:line 53
   at ServiceStack.Metadata.BaseMetadataHandler.ProcessOperationsAsync(Stream writer, IRequest httpReq, IResponse httpRes) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/Metadata/BaseMetadataHandler.cs:line 207

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

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.staging.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
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/x-msgpack
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"}}}