Skip to content
Snippets Groups Projects
Commit a336fb95 authored by Marco Holz's avatar Marco Holz
Browse files

Beispiel für `GET destinations/{destinationID}` aktualisiert

Closes #27
parent 1894c782
No related branches found
No related tags found
1 merge request!19Beispiel für `GET destinations/{destinationID}` aktualisiert
......@@ -14,11 +14,17 @@ Um eine Einreichung an die fachlich korrekte Stelle sicherzustellen und die tech
Um an einen Zustellpunkt eine Einreichung korrekt zu übermitteln, ist es notwendig, die im Zustellpunkt hinterlegten technischen Parameter für die Einreichung zu ermitteln.
Diese Informationen sind:
- Die zulässigen Fachdatenschemata (`submissionSchemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen.
Welches der dort angebenen Schemata verwendet werden muss, muss das sendende System aus dem eigenen fachlichen Kontext heraus bestimmen. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertausweis (bspw. ein FIM/XFall Schema) entsprechen.
- Der öffentliche Verschlüsselungsschlüssel (`kid` und `publicKeys`): Empfangende Systeme veröffentlichen in Form eines JSON Web Key Sets einen oder mehrere Public Keys für die Verschlüsselung der Einreichung. Welcher Public Key zum aktuellen Zeitpunkt für die Verschlüsselung genutzt werden muss, wird über den `kid` Parameter mitgeteilt.
- Die Verwaltungsleistungen (`services`), die über diesen Zustellpunkt abgebildet werden, bestehend aus:
- Einem Identifikator der Verwaltungsleitung (`identifier`). Typischerweise entspricht diese einer LeiKa-ID (siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)).
- Eine Liste an zulässigen Fachdatenschemata (`submissionSchemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen. Welches der angebenen Schemata verwendet werden muss, bestimmt das sendende System aus dem eigenen fachlichen Kontext heraus. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertausweis (bspw. ein FIM/XFall Schema) entsprechen.
- Eine Liste an Regionen (`regions`), für die die Verwaltungsleistung angeboten wird.
- Der öffentliche Verschlüsselungsschlüssel (`encryptionKid` und `publicKeys`): Empfangende Systeme veröffentlichen in Form eines JSON Web Key Sets einen oder mehrere Public Keys für die Verschlüsselung der Einreichung. Welcher Public Key zum aktuellen Zeitpunkt für die Verschlüsselung genutzt werden muss, wird über den `kid` Parameter mitgeteilt.
Hierzu stellt die Submission API einen Endpunkt bereit, der über den `destinationId` Parameter die technischer Parameter der Einreichung für den jeweiligen Zustellpunkt ausgibt.
:::caution
Der Mechanismus zum Abruf der Verschlüsselungsschlüssel wird sich bis zur Verföffentlichung der finalen API-Spezifikation noch einmal ändern.
:::
Zum Abruf der Zustellpunkt-Informationen stellt die Submission API einen Endpunkt bereit, der über Angabe des Parameters `destinationId` die technischen Parameter der Einreichung für den jeweiligen Zustellpunkt ausgibt.
<Tabs
defaultValue="curl"
......@@ -40,16 +46,26 @@ $ curl \
-X GET $SERVICE_URL/destinations/$DESTINATION_ID
> {
"destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047",
"submissionSchemas": [
"destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047",
"services": [
{
"identifier": "urn:de:fim:leika:leistung:99010003001006",
"submissionSchemas": [
{
"schemaURI": "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
"mimeType": "application/json"
}
],
"regions": [
"DE094750156156",
"DE09330411"
]
}
],
"encryptionKid": "c66e4423-e28d-4a1f-911d-818f9ab60221",
"publicKeys": {
"keys": [
{
"schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.xsd",
"mimeType": "application/xml"
}
],
"encryptionKid": "c66e4423-e28d-4a1f-911d-818f9ab60221",
"publicKeys": {
"keys": [{
"kty": "RSA",
"key_ops": [
"wrapKey"
......@@ -63,9 +79,10 @@ $ curl \
"kid": "c66e4423-e28d-4a1f-911d-818f9ab60221",
"n": "hGALqq-nbAymF5M...puHAyo3-iMf3UaBsPj0s",
"e": "AQAB"
}]
}
}
]
}
}
```
</TabItem>
</Tabs>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment