Report Filing Service

<back to all web services

RetrieveDac6Protocols

RetrieveDAC6Sync

Represents a request to retrieve DAC6 protocols.

Requires Authentication
The following routes are available for this service:
POST/sync/elma/dac6/protocols/retrieve
System.IO.InvalidDataException: MetaData is potentially malicious. Expected scalar value, Received: 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"
   at ServiceStack.NativeTypes.VbNet.VbNetGeneratorExtensions.SafeValue(String value) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/VbNet/VbNetGenerator.cs:line 790
   at ServiceStack.NativeTypes.VbNet.VbNetGeneratorExtensions.QuotedSafeValue(String value) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/VbNet/VbNetGenerator.cs:line 795
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.TypeValue(String type, String value) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/VbNet/VbNetGenerator.cs:line 573
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.AppendAttributes(StringBuilderWrapper sb, List`1 attributes) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/VbNet/VbNetGenerator.cs:line 561
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.AddProperties(StringBuilderWrapper sb, MetadataType type, Boolean includeResponseStatus) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/VbNet/VbNetGenerator.cs:line 483
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.AppendType(StringBuilderWrapper& sb, MetadataType type, String lastNS, List`1 allTypes, CreateTypeOptions options)
   at ServiceStack.NativeTypes.VbNet.VbNetGenerator.GetCode(MetadataTypes metadata, IRequest request, INativeTypesMetadata nativeTypes) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/VbNet/VbNetGenerator.cs:line 269
   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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sync/elma/dac6/protocols/retrieve HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	protocols: 
	[
		{
			id: String,
			schemaLocation: String,
			verfahren: CC,
			elmaKom: 
			{
				elmakomVersion: String,
				elmaHeader: 
				{
					datenArt: ELMA_CC,
					authSteuernummer: String,
					accountId: String,
					erstellungsDatum: 0001-01-01,
					kundeneigeneId: String,
					uuid: 00000000000000000000000000000000,
					verarbeitungslauf: PRODUKTIONSLAUF
				},
				elmaVerfahren: 
				{
					inhalt: {}
				}
			},
			elmaProtokoll: 
			{
				dateiname: String,
				authSteuernummer: String,
				accountId: String,
				verarbeitungsDatum: 0001-01-01,
				verarbeitungsZeit: 0001-01-01,
				status: ELMA_GLOBAL_UNBEKANNT,
				statusText: String,
				statusDetail: String,
				kundeneigeneId: String,
				uuid: 00000000000000000000000000000000
			},
			elmaFehler: 
			{
				dateiname: String,
				authSteuernummer: String,
				accountId: String,
				verarbeitungsDatum: 0001-01-01,
				verarbeitungsZeit: 0001-01-01,
				fehlerID: ELMA_GLOBAL_UNBEKANNT,
				fehlerText: String,
				fehlerProzess: String,
				kundeneigeneId: String,
				uuid: 00000000000000000000000000000000
			}
		}
	],
	files: 
	[
		{
			metadata: 
			{
				name: String,
				fullName: String,
				lastAccessTime: 0001-01-01,
				lastAccessTimeUtc: 0001-01-01,
				lastWriteTime: 0001-01-01,
				lastWriteTimeUtc: 0001-01-01,
				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
		}
	}
}