Fehlermeldung bei unbekannten Properties zurückgeben (war vormals: Persondendaten werden nicht übertragen)

europace / baufismart-kundenangaben-api

API zum Importieren von Kundenangaben in einen neuen Vorgang in BaufiSmart.

https://developer.europace.de

14 stars 4 forks source link

Fehlermeldung bei unbekannten Properties zurückgeben (war vormals: Persondendaten werden nicht übertragen) #105

Closed ic-hv closed 3 years ago

ic-hv commented 3 years ago

Ich musste - leider jetzt erst nach LIVE-Gang - feststellen, das die Personendaten wohl zwar sauber zu euch übetragen werden, diese aber nicht in dem Vorgang landen, alle anderen Daten sind da, aber die Personendaten fehlen:

daten daten2

Bitte ASAP lösen!

ElisaBaum commented 3 years ago

Hallo ic-hv,

da scheint sich ein Fehler bei den Daten eingeschlichen zu haben. Das Property heißt personendaten anstatt persondendaten. Mit dieser Korrektur sollten die Personendaten auch im Vorgang landen.

ic-hv commented 3 years ago

Ah ok, jetzt seh' ich es. Danke!

Könnte man die API aber vielleicht dahingehend anpassen, das sie bei unbekannten Properties eine Fehlermeldung zurückgibt? So weit ich mich erinnere hat die BEX-API das noch gemacht.

Weil es wäre schon gut, wenn man frühzeitig mitkriegen würde, das man da irgendwo nen Typo/Fehler drin hat, bevor die Daten dann einfach stillschweigend verlorengehen.

ElisaBaum commented 3 years ago

Hallo ic-hv,

die API wurde möglichst fehlertolerant designed. Es ist also beabsichtigt, dass unbekannte Properties zu keinem Fehler führen. Eine ausführlichere Begründung findest du hier.

Zur Validierung der Anfragedaten steht der Endpunkt /kundenangaben/body-validation zur Verfügung. Mit diesem können solche Fehler entdeckt werden.

ic-hv commented 3 years ago

Hallo Elisa,

leider fängt der Endpunkt /kundenangaben/body-validation derartige Tippfehler auch nicht ab. Der Request wird anstandslos akzeptiert. Wäre schön wenn man wenigstens durch Nutzung dieses Endpunkts auf unbekannte Properties hingewiesen werden würde ... ist das machbar?

ic-hv commented 3 years ago

Hintergrund ist, das die Kunden-Applikation Fälle aus dem kundenseitigen CRM via Kundenangaben-API zu Europace hochlädt und sich im späteren Verlauf via Vorgänge-API die Änderungen am Vorgang von Europace ins CRM zurücksynct (downloaded). Wenn jetzt eine Information im CRM vorhanden ist, aber evtl. von der Kundenangaben-API (wg. Tippfehler) verworfen wird und wir davon nichts mitkriegen, dann verschwindet diese Information endgültig auch aus dem Kunden-CRM beim nächsten Download des Vorgangs via Vorgänge-API ...

nar-ep commented 3 years ago

Hi ic-hv,

vielen Dank für das Feedback zur Kundenangaben-API. Wir haben deinen Feature Wunsch aufgenommen. Das Feature liegt nun in unserem Backlog und wird entsprechend der Priorisierung bearbeitet.