Anforderungen und Antworten

Anforderungen

Eine Anforderung ist ein Aufruf einer aufrufenden Anwendung an einen Endpunkt, um entweder Daten abzufragen oder eine Aktion zu initiieren.

Anforderungen werden über URLs gestellt. Anforderungs-URLs enthalten die folgenden Komponenten:

https://iap:8880/xc/rest/common/v1/activities/xc:207?fields=assignedGroup
\__________________/\______________________________/\___________________/ 
   application URL           endpoint path             query parameters

• Anwendungs-URL: Die URL zur InsuranceSuite-Anwendung.
  • Dieser Wert ist erforderlich.
• Endpunktpfad: Der Pfad zum spezifischen Endpunkt, den die Anforderung anfordert.
  • Dieser Wert ist erforderlich.
  • Endpunktpfade enden entweder mit einem Ressourcennamen (z. B. ../activities) oder die ID eines bestimmten Elements (z. B. ../activities/xc:207 im obigen Beispiel). Die ID eines bestimmten Elements wird auch als path-Parameter bezeichnet.
• Abfrageparameter: Dies ist ein Satz von Abfrageparametern, der die in der Antwort gewünschten Daten weiter definiert. Für die meisten Endpunkte sind Abfrageparameter optional.
  • Wenn Sie beispielsweise ?fields=assignedGroup hinzufügen, geben Sie an, dass das einzige Feld, das Sie in der Antwort zurückgeben möchten, das Feld assignedGroup ist.

Einige Anforderungen erfordern Nutzdaten. Die Nutzdaten sind ein Textblock im JSON-Format, der Informationen über eine oder mehrere Ressourcen enthält, die mit dem Vorgang verknüpft sind. In der Regel gilt:

• GETs und DELETEs erfordern keine Anforderungs-Nutzdaten.
  • Für ein GET müssen Sie nur die Ressource identifizieren, über die Sie Informationen erhalten möchten. Dies geschieht über die URL.
  • Bei einem DELETE müssen Sie nur das zu löschende Element identifizieren, und dies erfolgt über die URL.
• POSTs und PATCHs erfordern Anforderungsnutzdaten.
  • Für ein POST müssen Sie Daten über das zu erstellende Element angeben.
  • Für ein PATCH müssen Sie die Daten über das Element angeben, die aktualisiert werden müssen.

Antworten

Eine Antwort ist der Satz von Informationen, der von einem API-Endpunkt für eine Anforderung an die aufrufende Anwendung zurückgegeben wird.

Einige Antworten beinhalten Nutzdaten. Die Nutzdaten enthalten Informationen über eine oder mehrere Ressourcen, die vom Vorgang zurückgegeben werden. Für eine Anforderung zum Abrufen aller offenen Aktivitäten, die einem bestimmten Benutzer zugewiesen sind, enthält die Antwort beispielsweise Nutzdaten mit Informationen über die offenen Aktivitäten. Weitere Informationen zur Nutzdatenstruktur finden Sie unter GETs und Antwort-Nutzdatenstrukturen.

Das Ergebnis des Vorgangs wird als HTTP-Statuscode angegeben, auch als Antwortcode bezeichnet. Diese Codes sind dreistellige Zahlen. Die allgemeinen Bedeutungen dieser Codes sind in der folgenden Tabelle definiert: