From 6adfbaafb7cdcd9dbc075874ed59ac00222e1095 Mon Sep 17 00:00:00 2001 From: Marco Holz <marco.holz@fitko.de> Date: Fri, 20 Aug 2021 15:03:23 +0000 Subject: [PATCH] Abrufen von Submissions via Polling + Callbacks aktualisiert --- docs/getting-started/receiving/query.mdx | 28 +++++++++++++++++++----- 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/getting-started/receiving/query.mdx b/docs/getting-started/receiving/query.mdx index e659fd37a..a4afe6068 100644 --- a/docs/getting-started/receiving/query.mdx +++ b/docs/getting-started/receiving/query.mdx @@ -9,21 +9,26 @@ Letzteres wäre die präferierte Variante, da dadurch unnötige Anfragen vermied ## Callback Wenn eine neue Einreichung im Zustelldienst bereitsteht und eine Callback-URL im Zustellpunkt hinterlegt ist, kann der Zustelldienst den Zustellpunkt direkt informieren. -Das Format, in welchem der Callback übertragen wird, ist in der [API-Spezifikation](../../apis/delivery-service.mdx#post-/destinations) beschrieben. +Das Format, in welchem der Callback übertragen wird, im Endpunkt <ApiLink to="/destinations" withMethod="post" /> beschrieben. Im Endeffekt, ist es jedoch ein Array mit UUIDs für jede bereitstehende Einreichung, wie im Beispiel unten. ```json [ - "17a3abf4-8980-4000-89cb-dce5cdda9501" + "17b64151-fc80-4000-8fb7-6ddd08115780" ] ``` +:::caution Hinweis +Der Mechanismus zum Konfigurieren und Entgegennehmen von Callbacks wird sich bis zur Verföffentlichung der finalen API-Spezifikation noch einmal ändern. +::: + + Wenn der Zustellpunkt benachrichtigt wird, dann kann dieser über mehrere Befehle die Einreichung mit allen verbundenen Ressourcen herunterladen. Mehrere Befehle dahingehend, da erst alle allgemeinen Informationen zur Einreichung heruntergeladen werden müssen und dann, falls notwendig alle mit ihr verbundenen Anlagen. ## Polling -Über Polling, regelmäßiges Abfragen der Schnittstelle, können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen. +Über Polling, d.h. regelmäßiges Abfragen des Endpuntes <ApiLink to="/submissions" /> , können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen. Dies wird aus Performancegründen jedoch nocht empfohlen. ```bash $ export SERVICE_URL=<URL> @@ -32,9 +37,20 @@ $ curl \ -H "Authentication: Bearer $JWT_TOKEN" \ -H "Content-Type: application/json" \ -X GET $SERVICE_URL/submissions -> { - "submissions": [ - ... +> { + submissions: [ + { + destinationId: "879ee109-a690-4db8-ab32-424284184d7d", + submissionId: "ce75a6b8-d72f-4b94-b09e-af6be35bc2ae" + }, + { + destinationId: "19c8489b-29b8-422f-b7db-919852cfb04b", + submissionId: "e364430f-5a3b-4284-ba9a-f2867ba421e6" + }, + { + destinationId: "80a0aac3-148d-42bb-9366-516ce6355348", + submissionId: "530ba588-2db9-4899-ab0d-0c0b57689271" + } ] } ``` -- GitLab