Skip to content
Snippets Groups Projects
Commit 4bf7a881 authored by Klaus Fischer's avatar Klaus Fischer
Browse files

Updated docu

parent acd5284c
No related branches found
No related tags found
1 merge request!3Feature/440 mvp net sdk part 1
......@@ -39,20 +39,21 @@ Hierfür muss der Client die Environment auswählen oder einen eigenen Environme
ClientId und ClientSecret sind die Grundlage um einen Token vom OAuth-Server abfragen zu können.
Die beiden Werte sind im [Self-Service Portal der FIT Connect](https://portal.auth-testing.fit-connect.fitko.dev/clients)zu erstellen.
# Sender
```mermaid
flowchart TD
flowchart LR
start([GetSender])
destination[WithDestination]
service[WithServiceType]
attachments[WithAttachments]
destination(WithDestination)
service(WithServiceType)
attachments(WithAttachments)
data([WithData])
start-->destination-->service-->attachments-->data
```
Das SDK verhindert auf Grund der FluentAPI, dass die Methoden in der falschen Reihe aufgerufen werden können.
## GetSender(FitConnectEnvironment.Development, clientId, clientSecret, logger)
Hier werden die FIT Connect Environment ausgwählt und die Credentials übergeben.
......@@ -112,47 +113,63 @@ Der Subscriber braucht zusätzliche Informationen um die Submissions abrufen zu
Hier sind zusätzlich die Schlüssel zum Ver- und Entschlüsseln notwendig.
````mermaid
flowchart TD
flowchart LR
start([GetSubscriber])
destination[WithDestination]
service[WithServiceType]
attachments[WithAttachments]
data([WithData])
availableSub(GetAvailableSubmission)
requestSub(RequestSubmission)
subscriberWithSub([SubscriberWithSubmission])
subscriberWithSub_([SubscriberWithSubmission])
data(GetDataJson)
attachments(GetAttachments)
accept(AcceptSubmission)
reject(RejectSubmission)
forward(ForwardSumbission)
finished{{Abgeschlossen}}
rejected{{Zurueckgewiesen}}
start-->destination-->service-->attachments-->data
start-->availableSub-->requestSub-->subscriberWithSub
subscriberWithSub_-->data-->attachments
attachments-->accept-->finished
attachments-->reject-->rejected
attachments-->forward
````
## GetSubscriber(...)
## .GetSubscriber(...)
Hier werden die FIT Connect Environment ausgwählt, die Keys und die Credentials übergeben.
Der logger ist optional und muss das interface ```Microsoft.Extensions.Logging.ILogger``` implementieren.
## GetAvailableSubmissions()
## .GetAvailableSubmissions()
Liefert eine Liste mit den verfügbaren Submissions zurück.
## RequestSubmission(submissionId)
## .RequestSubmission(submissionId)
Hiermit wird die Submission abgerufen und im Subscriber gespeichert.
Der Rückgabewert der Funktion ist also _Subscriber mit einer Submission_
## GetDataJson()
## .GetDataJson()
Liefert die Fachdaten als JSON String zurück.
## GetAttachments()
## .GetAttachments()
Gibt eine Liste mit den Attachments der Submission zurück.
Die Attachments können so gebrüft werden.
## AcceptSubmission()
## .AcceptSubmission()
Akzepiert die Submission und löscht diese vom Server.
## RejectSubmission()
Weißt die Submission zurück.
## .RejectSubmission()
## ForwardSubmission()
Weißt die Submission zurück.
## .ForwardSubmission()
## Beispiel
......@@ -167,22 +184,20 @@ Weißt die Submission zurück.
var submissions = subscriber.GetAvailableSubmissions();
// Alle verfügbaren Submissions laden
foreach (var submission in submissions) {
var subscriberWithSubmission = subscriber.RequestSubmission(submission.SubmissionId);
// Laden der Anhänge
var attachments = subscriberWithSubmission
.GetAttachments();
// Ausgabe der Fachdaten auf der Konsole
logger.LogInformation("Fachdaten: {Data}", subscriberWithSubmission.GetDataJson());
subscriberWithSubmission
.AcceptSubmission();
// Submission akzeptieren und abschließen
subscriberWithSubmission.AcceptSubmission();
}
```
```mermaid
sequenceDiagram
Sender->>FitConnectServer: GetSubmissions
FitConnectServer->>Sender: Success
```
[glossary](https://docs.fitko.de/fit-connect/docs/glossary/)
......
......@@ -3,4 +3,4 @@ WORKDIR /test
COPY . .
RUN dotnet restore
RUN dotnet build
RUN dotnet test
RUN dotnet test --filter E2ETests.SenderTest
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