Skip to content
Snippets Groups Projects
Commit 6e00cbcd authored by Lilith Wittmann's avatar Lilith Wittmann
Browse files

update documentation on zustellberechtigunngsscopes

parent 903d33f4
No related branches found
No related tags found
No related merge requests found
# Zustellberechtigungs-Scope
Die Zustellberechtigungs-Scopes entscheiden darüber wohin ein Antrag zugestellt wird. Jeder Zustellpunkt eines spezifischen Antrags im FIT-Connect System verfügt über einen Zustellberechtigungs-Scope.
Ein Empfangspunkt kann dabei die Nachrichten für mehrere Zustellberechtigungs-Scopes empfangen und ein Antrag kann auch an mehrere Zustellberechtigungs-Scopes versendet werden.
Die Zustellberechtigungs-Scopes erlauben dem Zustelldienst festzustellen, ob ein dort eingesendeter Antrag vom Versennder an eine Destination übermittelt werden dar.
## Zusammensetzung der Zustellberechtigungs-Scopes
Eine Zustellberechtigungs-Scope ist immer eine ID in Verbindung mit einem Prefix für die Art der Leistung, die über sie zugestellt wird.
Der Zustellberechtigungsscope kann entweder direkt eine Destination-ID oder alternativ ein Scope sein. Diese Scopes beschränken entweder auf eine spzifische Art der Leistung, eine bestimmte Region oder eine Kombination aus Region und Leistung.
Ein Zustellberechtigungs-Scope kann den folgenden Typen entsprechen:
Das Format sieht dabei wie folgt aus
| Type | Beispiel | Erläuterung |
| ------------ | ------------------------------------------------ | ------------------------------------------------------------ |
| leika | leika:99108008252000 | LeiKa steht dafür, das die folgende ID einer Leistung im [Leistungskatalog der öffentlichen Verwaltung](https://leitfaden.ozg-umsetzung.de/display/OZG/2.1+Verwaltungsleistungen+im+Sinne+des+OZG) verzeichnet ist. |
| region | region:08110000 | Region steht für einen [Amtlichen Gemeindeschlüssel](https://de.wikipedia.org/wiki/Amtlicher_Gemeindeschl%C3%BCssel) |
| region-leika | region-leika:08110000:99108008252000 | Eine Kombination aus einem Amtlichen gemeindeschlüssel und einer LeiKa. Diese Schränken gemeinsam ein (diese Leistung in dieser Region) |
| Destination | destination:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1 | Die UUID einer in FIT-Connenct angelegten Destination. |
## Beispiele
LeiKa-Leistung für die [Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000):
```
[leika|custom]:[leika-ID|service-ID]:[Destination-UUID]
leika:99108008252000
```
| Feld | Inhalt | Erläuterung |
| ---------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Type | leika oder custom | Leika steht dafür, das die folgende ID einer Leistung im [Leistungskatalog der öffentlichen Verwaltung](https://leitfaden.ozg-umsetzung.de/display/OZG/2.1+Verwaltungsleistungen+im+Sinne+des+OZG) verzeichnet ist. Custom bedeutet, das es sich um eine Leistung handelt, die nicht Teil des Leistungskatalogs ist und nur in FIT-Connect angelegt wurde |
| ID | eine maximal 9-Stellige Nummer, die die Art des übermittelten Antrags angibt | Wenn der Typ "leika" entspricht, handelt es sich um eine ID, die einer Leistung im Leistungskatalog entspricht. Wenn der Typ "custom" entspricht, dann handelt es sich um eine ID, die einer Custom-Leistung im FIT-Connect Admin-Panel entspricht. |
| Destination-UUID | UUID der Destination | UUID der Destination, an die der Antrag versendet werden soll. |
Wenn ein Prefix für einenn AGS angegeben wird, schließt dieser alle sich darin befindlichen Subentitäten mit ein. Dieser Schlüssel steht für alle Leistungen in der Region Stuttgart und schließt alle darunterliegenden Gemeinden, Stadtteile, … mit ein:
## Beispiele
```
region:08110000
```
LeiKa-Leistung für die [Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000):
Die LeiKa-Leistung für die [Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000) in der Region Stuttgart:
```
leika:99108008252000:36141427-d405-40a4-8f8b-3592d544e85b
region-leika:08110000:99108008252000
```
Eine Custom-Leistung:
Eine spezfische Destination:
```
custom:1533:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1
destination:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1
```
Wenn eine Liste von Zustellberechtigungsscopes angegeben wird, sind diese immer getrennnt zu betrachten. Im folgenden Fall erden also alle Leistungen in der Regionn Stuttgart und die Leistung [Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000) in Brandenburg freigegeben.
```json
["region:08110000", "region-leika:12000000:99108008252000"]
```
## Regex zur Validierung
```
(custom|leika):([0-9]{4,15}):([0-9A-F]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89AB][0-9a-f]{3}-[0-9a-f]{12})
(leika:[0-9]{1,12})|(region-leika:[0-9]{1,12}:[0-9]{1,12})|(region:[0-9]{1,12})|(destination:[0-9A-F]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89AB][0-9a-f]{3}-[0-9a-f]{12}))
```
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