Document toolboxDocument toolbox

Technische Quittung / synchronous response

Als Richtlinie zur Implementierung der API Response wurde folgendes festgelegt:

  • Eine vollständig validierte 201 Response ist zu bevorzugen. Die Payload der Response enthält die angelegte / validierte Resource:
    •  mit id (vom Server definiert)
    •  mit initialem Statuswert (z.B. "acknowledged" für TMF622)
  • Falls mit der 201 Response die Validierung noch nicht vollständig synchron abgewickelt werden konnte, ist dennoch mit dem Status "acknowledged" zu antworten, und ein späterer Übergang von "acknowledged" auf "rejected" ist erlaubt.
  • Für den Fall, wenn der Server nicht in der Lage ist, die Duplikaten Validierung und die Vergabe der Resource id synchron zu realisieren (minimal Anforderung für eine 201 Response), ist eine 202 Response zu unterstützen. Hier ist zu beachten, dass die Vergabe und Meldung der id notwendig ist (EntityCreated Notification), bevor weitere Meldungen oder weitere Requests möglich sind. 
  • Mit der 202 Antwort soll das Request Objekt 1:1 zurück gemeldet werden.