EntwicklungsressourcenFöderale IT-StandardsPVOG - ein Produkt der Fitko
QuellcodeFeedback
Zum Hauptinhalt springen

AntwortTransfernachricht

anzahlObjekteinteger<int32>

Anzahl der Objekte innerhalb der Antwort. Diese Anzahl wird vom Server berechnet für eine performante Auslieferung. Um alle Objekte zu erhalten, müssen gegebenenfalls mehrere Anfragen gestellt werden. Die nächste Anfrage muss dann den Update-Index der letzten Antwort verwenden.

Example: 10
naechsterIndexinteger<int64>

Der für die nächste Anfrage benötigte Update-Index, um weitere Antwortobjekte zu erhalten.

Example: 12345
naechsteAnfrageUrlstring<url>

Vorgefertigte URL der nächsten Anfrage.

Example: https://.../bereitstelldienst/api/v1/verwaltungsobjekte?ars=02%25&index=12345
vollstaendigboolean

Boolean der anzeigt, ob alle Daten für den aktuellen Datenabruf übermittelt wurden (true) oder ob noch Updates vorhanden sind (false).

Example: true
xzufiObjektestring

Die angeforderten Objekte im XZuFi-Format.

Example: <?xml version="1.0" encoding="UTF-8"?><xzufi:transfer.operation.040502 produktbezeichnung="PVOG" produkthersteller="Dataport AöR" xmlns:xzufi="http://xoev.de/schemata/xzufi/2_2_0" xzufiVersion="2.2.0">...</xzufi:transfer.operation.040502>
AntwortTransfernachricht
{
"anzahlObjekte": 10,
"naechsterIndex": 12345,
"naechsteAnfrageUrl": "https://.../bereitstelldienst/api/v1/verwaltungsobjekte?ars=02%25&index=12345",
"vollstaendig": true,
"xzufiObjekte": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><xzufi:transfer.operation.040502 produktbezeichnung=\"PVOG\" produkthersteller=\"Dataport AöR\" xmlns:xzufi=\"http://xoev.de/schemata/xzufi/2_2_0\" xzufiVersion=\"2.2.0\">...</xzufi:transfer.operation.040502>"
}