Übersicht über GETs

Ein GET ist eine HTTP-Methode, die zum Abrufen von Daten aus einer InsuranceSuite-Anwendung verwendet wird.

Im einfachsten Format besteht ein GET aus der GET-Operation und dem Endpunkt, z. B. GET /activities. Ein GET kann entweder Informationen über ein einzelnes Element (z. B. GET /activities/{activityId}) oder Informationen über eine Sammlung (z. B. GET /activities/{activityId}/notes) zurückgeben.

Die Antwort auf ein GET umfasst:

  • Einen HTTP-Antwortcode, der Erfolg oder Fehler angibt.
  • Antwort-Nutzdaten, welche die abgefragten Daten enthalten.

Wenn ein Entwickler eine aufrufende Anwendung so konfiguriert, dass Informationen mit einem GET abgefragt werden, erfolgt die Erstellung des API-Aufrufs recht unkompliziert. Der Aufruf kann Abfrageparameter erfordern, GETs erfordern jedoch keine Anforderungs-Nutzdaten.

Der größte Teil der Arbeit liegt in der Analyse der Antwort-Nutzdaten. Der Rest dieses Kapitels beschreibt, wie Antwort-Nutzdaten strukturiert sind und wie sich Entwickler über Antwort-Nutzdatenformate informieren können.