OpenApi 3.0 Exchange-JSON

{"openapi":"3.0.1","info":{"title":"Digital Checkin API","version":"v1"},"servers":[{"url":"http://localhost:8024","description":"Generated server url"}],"tags":[{"name":"Exchange Controller"}],"paths":{"/api/exchange/{traegerId}/{systemId}/kurse":{"put":{"tags":["Exchange Controller"],"operationId":"importKurseArray","parameters":[{"name":"traegerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"text/csv":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},"application/octet-stream":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportResult"}}}}},"security":[{"basicAuth":[]}]}},"/api/exchange/{traegerId}/{systemId}/kurse/{kursId}/teilnehmer":{"get":{"tags":["Exchange Controller"],"operationId":"exportTeilnehmer","parameters":[{"name":"traegerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}},{"name":"kursId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{},"application/octet-stream":{},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportedTeilnehmer"}}}}}},"security":[{"basicAuth":[]}]},"put":{"tags":["Exchange Controller"],"operationId":"importTeilnehmerArray_1","parameters":[{"name":"traegerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}},{"name":"kursId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"text/csv":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},"application/octet-stream":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportedTeilnehmer"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportResult"}}}}},"security":[{"basicAuth":[]}]}},"/api/exchange/{traegerId}/{systemId}/kurse/":{"get":{"tags":["Exchange Controller"],"operationId":"exportKurse","parameters":[{"name":"traegerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{},"application/octet-stream":{},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportedKurs"}}}}}},"security":[{"basicAuth":[]}]},"put":{"tags":["Exchange Controller"],"operationId":"importKurseJson","parameters":[{"name":"traegerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportedKurs"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportResult"}}}}},"security":[{"basicAuth":[]}]}},"/api/exchange/{traegerId}/{systemId}/kurse/{kursId}/anwesenheiten/{tag}":{"get":{"tags":["Exchange Controller"],"operationId":"exportAnwesenheiten","parameters":[{"name":"traegerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}},{"name":"kursId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tag","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/csv":{},"application/octet-stream":{},"application/json":{"schema":{"$ref":"#/components/schemas/ExportedAnwesenheitsliste"}}}}},"security":[{"basicAuth":[]}]}}},"components":{"schemas":{"ImportLine":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"responseText":{"type":"string"},"ok":{"type":"boolean"}}},"ImportResult":{"type":"object","properties":{"lines":{"type":"array","items":{"$ref":"#/components/schemas/ImportLine"}}}},"ExportedTeilnehmer":{"required":["displayName","externeId","status"],"type":"object","properties":{"externeId":{"type":"string"},"displayName":{"type":"string"},"email":{"type":"string"},"anmeldeDatum":{"type":"string","format":"date"},"publicKey":{"type":"string"},"status":{"type":"string","enum":["NONE","REGISTERED","CHECKEDIN","CANCELED"]}}},"ExportedKurs":{"required":["externesSystem","kursnummer"],"type":"object","properties":{"kursnummer":{"type":"string"},"externesSystem":{"type":"string"},"bezeichnung":{"type":"string"},"kursStatus":{"type":"string","enum":["REGISTERED","OPEN","RUNNING","DONE","ARCHIVED"]},"zusatz":{"type":"string"},"tags":{"type":"string"},"kursBeginn":{"type":"string","format":"date"},"kursEnde":{"type":"string","format":"date"},"schulungsstaette":{"$ref":"#/components/schemas/ExportedSchulungsstaette"},"publicKey":{"type":"string"},"did":{"type":"string"},"lehrkraefte":{"type":"array","items":{"$ref":"#/components/schemas/ExportedKursPersonal"}},"praesenzUnterricht":{"type":"array","items":{"$ref":"#/components/schemas/UnterrichtszeitenDto"}},"onlineUnterricht":{"type":"array","items":{"$ref":"#/components/schemas/UnterrichtszeitenDto"}},"unterbrechungen":{"type":"array","items":{"$ref":"#/components/schemas/KursUnterbrechungDto"}},"sondertage":{"type":"array","items":{"$ref":"#/components/schemas/KursSondertagDto"}}}},"ExportedKursPersonal":{"required":["email","externeId","name"],"type":"object","properties":{"externeId":{"type":"string"},"lehrkraftTyp":{"type":"string","enum":["SOZIALPAEDAGOGE","FACHKRAFT"]},"name":{"type":"string"},"email":{"type":"string"},"deaktiviert":{"type":"boolean"}}},"ExportedSchulungsstaette":{"required":["bezeichnung","externeId","externesSystem"],"type":"object","properties":{"bezeichnung":{"type":"string"},"strasse":{"type":"string"},"hausnummer":{"type":"string"},"adresszusatz":{"type":"string"},"land":{"type":"string"},"plz":{"type":"string"},"ort":{"type":"string"},"externeId":{"type":"string"},"externesSystem":{"type":"string"}}},"KursSondertagDto":{"required":["bis","datum","von"],"type":"object","properties":{"datum":{"type":"string","format":"date"},"von":{"type":"string","example":"09:09"},"bis":{"type":"string","example":"09:09"},"bezeichnung":{"type":"string"},"abweichendeSst":{"$ref":"#/components/schemas/SchulungsstaetteDto"}}},"KursUnterbrechungDto":{"required":["begruendung","bis","unterbrechungsart","von"],"type":"object","properties":{"von":{"type":"string","format":"date"},"bis":{"type":"string","format":"date"},"unterbrechungsart":{"type":"string","enum":["GEPLANT","UNGEPLANT","URLAUB"]},"begruendung":{"type":"string"}}},"SchulungsstaetteDto":{"required":["bezeichnung","externalId"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"bezeichnung":{"type":"string"},"strasse":{"type":"string"},"hausnummer":{"type":"string"},"adresszusatz":{"type":"string"},"land":{"type":"string"},"plz":{"type":"string"},"ort":{"type":"string"},"externalId":{"type":"string"},"externalSystem":{"type":"string"}}},"UnterrichtszeitenDto":{"type":"object","properties":{"tag":{"type":"string","enum":["MONTAG","DIENSTAG","MITTWOCH","DONNERSTAG","FREITAG","SAMSTAG","SONNTAG"]},"zeitraumDto":{"$ref":"#/components/schemas/ZeitraumDto"}}},"ZeitraumDto":{"type":"object","properties":{"von":{"type":"string","example":"09:09"},"bis":{"type":"string","example":"09:09"}}},"ExportedAnwesenheitsliste":{"type":"object","properties":{"teilnehmer":{"type":"array","items":{"$ref":"#/components/schemas/ExportedTeilnehmerAnwesenheit"}},"datum":{"type":"string","format":"date"},"signed":{"type":"boolean"},"closed":{"type":"boolean"}}},"ExportedTeilnehmerAnwesenheit":{"type":"object","properties":{"externeId":{"type":"string"},"displayName":{"type":"string"},"anwesenheitStatus":{"type":"string","enum":["AUSSTEHEND","ANWESEND","ENTSCHULDIGT","FEHLEND"]},"eingecheckt":{"type":"boolean"},"verspaetet":{"type":"boolean"},"checkoutVorEnde":{"type":"boolean"},"begruendung":{"type":"string"},"filename":{"type":"string"}}}},"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}}}}