{ "openapi": "3.0.1", "info": { "title": "Advoware Connector", "description": "

Diese API ist work in progress und wird fortlaufend überarbeitet. Änderungen - auch inkompatible - können jederzeit vorgenommen werden.

", "version": "v1 für Mitarbeiter" }, "paths": { "/api/v1/advonet/File": { "get": { "tags": [ "File" ], "summary": "Download einer Datei aus der Aktengeschichte", "parameters": [ { "name": "guid", "in": "query", "description": "Falls nicht leer, wird die zugehörige Datei heruntergeladen.", "schema": { "type": "string" } }, { "name": "hnr", "in": "query", "description": "Falls >0 wird eine Guid erzeugt, die zum Herunteraden in einem weiteren Aufruf angegeben wird. Die Guid ist 24 lang gültig.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "nr", "in": "query", "description": "Falls >0 wird Array mit Dateiinformationen zu der Aktengeschichte dieser Akte zurückgegeben.", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "File" ], "summary": "Upload einer Datei int die Aktengeschichte", "description": "Felder im Formular sind nr (Aktennummer, null möglich), art (Art des Eintrags, null möglich), bemerkung (null möglich), file (Dateidaten), mitarbeiternr (optional), mitarbeiterkuerzel (optional), ordnernr (optional)", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "formData": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringValuesKeyValuePair" } } } }, "encoding": { "formData": { "style": "form" } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "formData": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringValuesKeyValuePair" } } } }, "encoding": { "formData": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileHnr" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileHnr" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileHnr" } } } } } } }, "/api/v1/advonet/AbrechnungsArten": { "description": "AbrechnungsArten", "get": { "tags": [ "AbrechnungsArten" ], "summary": "Liste der mögliche Werte für die Abrechnungsarten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetAbrechnungsArten", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Akte": { "description": "Akte", "get": { "tags": [ "Akte" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetAkte", "parameters": [ { "name": "nr", "in": "query", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "basic", "in": "query", "description": "Wenn true, werden nur Aktenstammdaten zurückgegeben. Optional - Standardwert false.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Aktendaten mit optionalen zugehörigen Daten wie Beteiligte, Termine, etc.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AkteComplex" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true }, "post": { "tags": [ "Akte" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfNewAkte", "requestBody": { "description": "Aktendaten. Die Felder nr und az werden ignoriert. Neue Werte werden bei der Aktenanlage generiert.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AkteParameter" } } } }, "responses": { "201": { "description": "Nummer der neuen Akte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Aktennummer" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Akten": { "description": "Akten", "get": { "tags": [ "Akten" ], "summary": "Gibt eine Liste von Akten, für die die Suchkriterien zutreffen, zurück (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetAkten", "parameters": [ { "name": "az", "in": "query", "description": "Aktenzeichen", "schema": { "type": "string" } }, { "name": "rubrum", "in": "query", "description": "Rubrum / Kurzbezeichnung der Akte", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Rubrum und Aktenzeichen werden nach dieser Zeichenfolge durchsucht.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Rubrum und Aktenzeichen werden nach dieser Zeichenfolge durchsucht.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Index des ersten Elementes in der Ergebnisliste", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Maximale Länge der Ergebnisliste (max. 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Liste mit Aktenstammdaten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Akte" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "put": { "tags": [ "Akten" ], "summary": "Verändert eine bestehende Akte (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfModifyAkte", "requestBody": { "description": "Aktendaten. Nr = die zuverändernde Akte. Die Felder nr und az werden ignoriert.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Akte" } } } }, "responses": { "200": { "description": "Die veränderte Akte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Akte" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Akten" ], "summary": "Erstellt eine neue Akte (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfNewAkten", "requestBody": { "description": "Aktendaten. Die Felder nr und az werden ignoriert. Neue Werte werden bei der Aktenanlage generiert.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AkteParameter" } } } }, "responses": { "201": { "description": "Akte", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Akte" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Akten/{akteId}": { "description": "Akten/{akteId:int}", "get": { "tags": [ "Akten" ], "summary": "Gibt die Akte mit der Aktennummer {id} zurück (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetAktenByNrMitarbeiter", "parameters": [ { "name": "basic", "in": "query", "description": "Wenn \"true\", werden nur Aktenstammdaten zurückgegeben. Optional - Standardwert false.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Liste mit einem Eintrag der Akte zur Aktennummer mit optionalen zugehörigen Daten wie Beteiligte, Termine, etc.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AkteComplex" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Akten/{akteId}/Beteiligte": { "description": "Akten/{akteId:int}/Beteiligte", "get": { "tags": [ "Akten" ], "summary": "Ruft Beteiligte zur Akte ab. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetAkteBeteiligte", "responses": { "200": { "description": "Beteiligte zur Akte", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Beteiligter" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Akten/{akteId}/Directory": { "description": "Akten/{akteId:int:length(10)}/Directory", "get": { "tags": [ "Akten" ], "summary": "Gibt den Verzeichnispfad für den Dokumentenordner der Akte zurück. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetAktenDir", "responses": { "200": { "description": "Verzeichnispfad", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Akten/{akteId}/History": { "description": "Akten/{akteId:int:length(10)}/History", "get": { "tags": [ "Akten" ], "summary": "Gibt eine Liste von Daten aus der Aktengeschichte der Akte mit der Aktennummer {id} zurück (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAktenHistoryGet", "parameters": [ { "name": "filter", "in": "query", "description": "Filtert nur Dateien, alles außer Dateien oder gibt alles zurück.\n\n0 = ALLES\n\n1 = NUR_DATEIEN\n\n2 = KEINE_DATEIEN", "schema": { "$ref": "#/components/schemas/HistoryQueryParam" } }, { "name": "tags", "in": "query", "description": "Mit ',' Komma getrennte Tag-Liste. Liefert nur Einträge mit mindestens einem Treffer bei den Tags.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste mit Aktengeschichteeinträgen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryEntry" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Akten" ], "summary": "Aktengeschichteeintrag zu einer Akte anlegen (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddAktenHistory", "requestBody": { "description": "Parameter für die Anlage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryParameter" } } } }, "responses": { "201": { "description": "Der neuen Aktengeschichteeintrag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryEntry" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Akten/{akteId}/MandantenHonorarSaldo": { "description": "Akten/{akteId:int}/MandantenHonorarSaldo", "get": { "tags": [ "Akten" ], "summary": "Information über geforderte und bezahlte Beträge (All)", "description": "**Valid roles:** All
", "operationId": "CfAktenSaldoGet", "responses": { "200": { "description": "Akten Saldo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AktenHonorarSaldo" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Akten/{akteId}/ReferatspezifscheDaten2": { "description": "Akten/{akteId:int}/ReferatspezifscheDaten2", "get": { "tags": [ "Akten" ], "summary": "Referatsspezifische Daten zu einer Akte auslesen (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfRefData2Get", "responses": { "200": { "description": "Generisches Dictionary", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "put": { "tags": [ "Akten" ], "summary": "Referatsspezifische Daten in eine Akte schreiben (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfAktenRefData2Put", "requestBody": { "description": "Generisches Dictionary angepasst an die Tabellenstruktur des Referats.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "200": { "description": "true, wenn für die Akte noch keine Daten gespeichert waren. false, wenn vorhandene Daten überschrieben wurden.", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Akten/{akteId}/Unfall": { "description": "Akten/{akteId:int}/Unfall", "get": { "tags": [ "Akten" ], "summary": "Ruft Unfalldaten einer Akte ab, sofern vorhanden. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetRefDataUnfall", "responses": { "200": { "description": "Unfalldaten zur Akte", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Unfall" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Akten" ], "summary": "Fügt einer Akte Daten zum Unfall hinzu. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddRefDataUnfall", "requestBody": { "description": "Die zu erstellenden Unfalldaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnfallParameter" } } } }, "responses": { "201": { "description": "Die erstellten Unfalldaten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Unfall" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "delete": { "tags": [ "Akten" ], "summary": "Löscht die Unfalldaten einer Akte, sofern vorhanden. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfDeleteRefDataUnfall", "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/AktenDir": { "description": "AktenDir", "get": { "tags": [ "AktenDir" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetAktenDirAlt", "parameters": [ { "name": "nr", "in": "query", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Verzeichnispfad", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/AktenSaldo": { "description": "AktenSaldo", "get": { "tags": [ "AktenSaldo" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (All)", "description": "**Valid roles:** All
", "operationId": "CfAktenSaldoGetAlt", "parameters": [ { "name": "Aktennummer", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/Aktennummer" } } ], "responses": { "200": { "description": "Akten Saldo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AktenHonorarSaldo" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Bankverbindungen": { "description": "Bankverbindungen", "get": { "tags": [ "Bankverbindungen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBankverbindungenAlt", "parameters": [ { "name": "betnr", "in": "query", "description": "betnr des Beteiligten", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Liste der Bankverbindungen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bankverbindung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Beteiligte": { "description": "Beteiligte", "get": { "tags": [ "Beteiligte" ], "summary": "Suche Beteiligte, die den Suchkriterien entsprechen, oder gibt die Daten zu einem Beteiligten zurück. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
Mindestens ein Suchkriterium muss angegeben werden oder die Id des Beteiligten.", "operationId": "CfGetBeteiligte", "parameters": [ { "name": "betnr", "in": "query", "description": "Id des Beteiligten.", "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Der Nachname wird nach dieser Zeichenkette durchsucht.", "schema": { "type": "string" } }, { "name": "vorname", "in": "query", "description": "Der Vorname wird nach dieser Zeichenkette durchsucht.", "schema": { "type": "string" } }, { "name": "ort", "in": "query", "description": "Der ort wird nach dieser Zeichenkette durchsucht.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximale Anzahl der zurückgegebenen Beteiligten.", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "Index des Eintrags, der der erste in der Liste der Suchergebnisse ist.", "schema": { "type": "integer", "format": "int32" } }, { "name": "liBetnr", "in": "query", "description": "Liste mit Beteiligten-Ids in Json-Notation", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Liste der Beteiligten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Beteiligter" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Beteiligte" ], "summary": "Erstelle einen Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddBeteiligter", "requestBody": { "description": "der zu erstellende Beteiligte, Rechtsform muss Teil der Liste GET /Rechtsformen sein", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeteiligterParameter" } } } }, "responses": { "201": { "description": "BetNr des erstellten Beteiligten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeteiligteNrParam" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Beteiligte/{beteiligterId}": { "description": "Beteiligte/{beteiligterId:int}", "get": { "tags": [ "Beteiligte" ], "summary": "Gibt die Daten zu einem Beteiligten zurück. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligteById", "responses": { "200": { "description": "Der Beteiligte", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeteiligterComplexBetNr" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "put": { "tags": [ "Beteiligte" ], "summary": "Ändert Daten eines Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfModifyBeteiligter", "requestBody": { "description": "Zu ändernde Daten, Rechtsform muss Teil der Liste GET /Rechtsformen sein", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeteiligterParameter" } } } }, "responses": { "200": { "description": "Liste mit einem geänderten Datensatz des Beteiligten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Beteiligter" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "ID = BETNR", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Adressen": { "description": "Beteiligte/{beteiligterId:int}/Adressen", "get": { "tags": [ "Beteiligte" ], "summary": "Adressen eines Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligteAdressen", "responses": { "200": { "description": "Liste mit Adressen des Beteiligten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Adresse" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Beteiligte" ], "summary": "Adresse für einen Beteiligten hinzufügen (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddBeteiligteAdressen", "requestBody": { "description": "Adressdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdresseParameter" } } } }, "responses": { "201": { "description": "Liste mit Adressen des Beteiligten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Adresse" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "Beteiligten ID (BetNr)", "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Adressen/{adresseId}": { "description": "Beteiligte/{beteiligterId:int}/Adressen/{adresseId:int}", "put": { "tags": [ "Beteiligte" ], "summary": "Adresse eines Beteiligten ändern (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPutBeteiligteAdresse", "requestBody": { "description": "Adressdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdresseParameter" } } } }, "responses": { "200": { "description": "Aktualisierte Adressdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Adresse" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "Beteiligten ID (BetNr)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "adresseId", "in": "path", "description": "Adress Nr", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Akten/{akteId}/Beteiligungen": { "description": "Beteiligte/{beteiligterId:int}/Akten/{akteId:int:length(10)}/Beteiligungen", "post": { "tags": [ "Beteiligte" ], "summary": "Füge einen Beteiligten einer Akte hinzu (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
Beteiligtenart (Mandant, Gegner, ...) wird über die kz gesetzt, eine Liste gibt es unter GET /BeteiligteArten. master: Id des übergeordneten Beteiligten, wenn ebene>1", "operationId": "CfAddBeteiligungen", "requestBody": { "description": "Daten zur Beteiligung (art, kz, master)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetAktParameter" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetAktParameter" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "delete": { "tags": [ "Beteiligte" ], "summary": "Entferne einen Beteiligten aus einer Akte (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfDeleteBeteiligung", "requestBody": { "description": "Beteiligung", "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "Beteiligtennummer", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Bankverbindungen": { "description": "Beteiligte/{beteiligterId:int}/Bankverbindungen", "get": { "tags": [ "Beteiligte" ], "summary": "Bankverbindungen eines Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBankverbindungen", "responses": { "200": { "description": "Liste der Bankverbindungen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bankverbindung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Beteiligte" ], "summary": "Erstellt eine Bankverbindung für einen Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddBankverbindung", "requestBody": { "description": "Die zu erstellende Bankverbindung", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankverbindungParameter" } } } }, "responses": { "201": { "description": "Die erstellte Bankverbindung", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Bankverbindung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "betNr des Beteiligten", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Beteiligungen": { "description": "Beteiligte/{beteiligterId:int}/Beteiligungen", "get": { "tags": [ "Beteiligte" ], "summary": "Beteiligungen eines Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligungen", "responses": { "200": { "description": "Die Beteiligungen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Beteiligung" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "Die BetNr des Beteiligten.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Kommunikationen": { "description": "Beteiligte/{beteiligterId:int}/Kommunikationen", "post": { "tags": [ "Beteiligte" ], "summary": "Erstellt eine Kommunikation für einen Beteiligten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddKommunikation", "requestBody": { "description": "Die zu erstellende Kommunikation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KommunikationParameter" } } } }, "responses": { "201": { "description": "Die erstellte Kommunikation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Kommunikation" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "Id des Beteiligten", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Kommunikationen/{kommunikationId}": { "description": "Beteiligte/{beteiligterId:int}/Kommunikationen/{kommunikationId:int}", "put": { "tags": [ "Beteiligte" ], "summary": "Kommunikation eines Beteiligten ändern (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPutBeteiligteKommunikation", "requestBody": { "description": "Kommunikationsdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KommunikationParameter" } } } }, "responses": { "200": { "description": "Aktualisierte Kommunikationsdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Kommunikation" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "Beteiligten ID (BetNr)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "kommunikationId", "in": "path", "description": "Kommunikation Nr", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/{beteiligterId}/Kontaktpersonen": { "description": "Beteiligte/{beteiligterId:int}/Kontaktpersonen", "post": { "tags": [ "Beteiligte" ], "summary": "Kontaktperson zu einem Beteiligten hinzufügen (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddKontaktperson", "requestBody": { "description": "Daten zur Kontaktperson", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KontaktpersonParameter" } } } }, "responses": { "201": { "description": "Daten zur Kontaktperson", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Kontaktperson" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligterId", "in": "path", "description": "ID des Beteiligten", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Beteiligte/Anreden": { "description": "Beteiligte/Anreden", "get": { "tags": [ "Beteiligte" ], "summary": "Liefert eine Liste mit Anreden und Briefanreden (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligteAnreden", "responses": { "200": { "description": "Die Anreden, Briefanreden", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Anrede" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Beteiligte/Arten": { "description": "Beteiligte/Arten", "get": { "tags": [ "Beteiligte" ], "summary": "Rückgabe aller Beteiligtenarten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligteArten", "responses": { "200": { "description": "Liste der Beteiligtenarten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BetIns" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Beteiligte" ], "summary": "Anlegen einer neuen Beteiligtenart (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddBeteiligteArt", "requestBody": { "description": "Daten zur Beteiligtenart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetInsParameter" } } } }, "responses": { "201": { "description": "Rückgabe der angelegten Art", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetIns" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Beteiligte/Arten/{beteiligtenartId}": { "description": "Beteiligte/Arten/{beteiligtenartId:int}", "get": { "tags": [ "Beteiligte" ], "summary": "Abruf einer spezifischen Beteiligtenart (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligteArt", "responses": { "200": { "description": "Liste mit einer Beteiligtenart", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BetIns" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "beteiligtenartId", "in": "path", "description": "Beteiligtenart -ID (KZ)", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/BeteiligteArten": { "description": "BeteiligteArten", "get": { "tags": [ "BeteiligteArten" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligteArtenAlt", "responses": { "200": { "description": "Liste der Beteiligtenarten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BetIns" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Beteiligter": { "description": "Beteiligter", "get": { "tags": [ "Beteiligter" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligter", "parameters": [ { "name": "betnr", "in": "query", "description": "Die betnr des Beteiligten.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Der Beteiligte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Beteiligter" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Beteiligung": { "description": "Beteiligung", "post": { "tags": [ "Beteiligung" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
art: Beteiligtenart (Mandant, Gegner, ...), kz: Kennzahl der Beteiligtenart. Wenn agegeben, wir art ignoriert. master: Id des übergeordneten Beteiligten, wenn ebene>1 ", "operationId": "CfAddBeteiligungAlt", "requestBody": { "description": "Daten zur Beteiligung (art, kz, master)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetAktMitNr" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetAktMitNr" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true }, "delete": { "tags": [ "Beteiligung" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
nr: Aktennummer, betnr: Beteiligtennummer; andere Werte werden ignoriert", "operationId": "CfDeleteBeteiligungAlt", "requestBody": { "description": "Beteiligung", "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Beteiligungen": { "description": "Beteiligungen", "get": { "tags": [ "Beteiligungen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetBeteiligungenAlt", "parameters": [ { "name": "betnr", "in": "query", "description": "Die betnr des Beteiligten.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Die Beteiligungen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Beteiligung" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Buchungen": { "description": "Buchungen", "get": { "tags": [ "Buchungen" ], "summary": "Gibt eine Liste von Buchungen, die den Suchkriterien entsprechen, zurück (All)", "description": "**Valid roles:** All
", "operationId": "CfBuchungenGet", "parameters": [ { "name": "AktenNummern", "in": "query", "description": "Liste mit Aktennummern im Json-Format", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "ZeitraumStart", "in": "query", "description": "Zeitraum von", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ZeitraumStop", "in": "query", "description": "Zeitraum bis", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "BNr", "in": "query", "description": "Buchungsnummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Buchung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Chat": { "description": "Chat", "post": { "tags": [ "Chat" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPostChatAlt", "requestBody": { "description": "Titel, Akte, Mitarbeiter-Ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewChat" } } } }, "responses": { "201": { "description": "Id der neuen Konversation", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true }, "delete": { "tags": [ "Chat" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
Wenn \"Partner\" nicht angeben ist, wird die komplette Konversation gelöscht", "operationId": "CfDeleteChatAlt", "parameters": [ { "name": "ChatId", "in": "query", "description": "Id der Konversation", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Partner", "in": "query", "description": "Mitarbeiternummer des Teilnehmers", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Chat/{chatId}": { "description": "Chat/{chatId:int?}", "get": { "tags": [ "Chat" ], "summary": "Eine Konversation des angemeldeten Mitarbeiters zurückgeben. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
Es kann die Konversations-Id angegeben werden oder, falls eine Konversation mit zwei Teilnehmern gesucht wird, die Id des anderen Teilnehmers und ggf. die Aktennnummer", "operationId": "CfGetChatAlt", "parameters": [ { "name": "Partner", "in": "query", "description": "Id des anderen Mitarbeiters der Konversation", "schema": { "type": "integer", "format": "int32" } }, { "name": "Akte", "in": "query", "description": "Aktennummer, zu der Konversation zugeordnet ist.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Konversation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "chatId", "in": "path", "description": "Id der Konversation", "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/ChatMessage": { "description": "ChatMessage", "post": { "tags": [ "ChatMessage" ], "summary": "Neue Nachricht an einen Mitarbeiter schicken inkl. Push-Benachrichtigungen. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
Absender ist der angemeldete Mitarbeiter. Falls keine passende Konversation existiert, wird eine neue erstellt.", "operationId": "CfPostChatMessage", "requestBody": { "description": "Nachricht und entweder Id der Konversation oder Partner und ggf. Aktennummer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "responses": { "201": { "description": "Konversations-Id, NachrichtenId, ggf. Rubrum und Aktennummer, Liste der Empfänger-Ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/INewMessageResult" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Chats": { "description": "Chats", "get": { "tags": [ "Chats" ], "summary": "Alle Konversationen für den angemeldeten Mitarbeiter zurückgeben (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetChats", "responses": { "200": { "description": "Liste der Konversationen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Chat" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Chats" ], "summary": "Eine neue Konversation erstellen. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPostChat", "requestBody": { "description": "Titel, Akte, Mitarbeiter-Ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewChat" } } } }, "responses": { "201": { "description": "Id der neuen Konversation", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Chats/{chatId}": { "description": "Chats/{chatId:int:required}", "delete": { "tags": [ "Chats" ], "summary": "Löscht eine komplette Konversation. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfDeleteChat", "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "chatId", "in": "path", "description": "ID der Konversation", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Chats/{chatId}/Partner/{teilnehmerId}": { "description": "Chats/{chatId:int:required}/Partner/{teilnehmerId:int:required}", "delete": { "tags": [ "Chats" ], "summary": "Löscht einen Teilnehmer aus einer Konversation. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfDeleteChatPartner", "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "chatId", "in": "path", "description": "ID der Konversation", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "teilnehmerId", "in": "path", "description": "ID des Teilnehmers", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Delay": { "description": "Delay", "get": { "tags": [ "Delay" ], "summary": "Wartet eine angegebene Zeit (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfWaitForDelay", "parameters": [ { "name": "delay", "in": "query", "description": "Delay in ms.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "query", "description": "Id des requests.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Nummer der neuen Akte", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Feiertage": { "description": "Feiertage", "get": { "tags": [ "Feiertage" ], "summary": "Gibt eine Liste der Feiertage zurück (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetFeiertage", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Feiertag" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/FileInfo/{historyEntryId}/{details}": { "description": "FileInfo/{historyEntryId:int?}/{details?}", "get": { "tags": [ "FileInfo" ], "summary": "Informationen des Dateianhangs zu einem Aktengeschichteeintrag holen. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetFileInfo", "responses": { "200": { "description": "Größe in Bytes, Änderungsdatum, Erstellungsdatum, Dateiname der Datei", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileInfos" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "historyEntryId", "in": "path", "description": "Nummer des Aktengeschichteeintrags", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Forderungen": { "description": "Forderungen", "post": { "tags": [ "Forderungen" ], "summary": "Eine neue Forderungen erstellen (All)", "description": "**Valid roles:** All
", "operationId": "CfForderungenPost", "requestBody": { "description": "Feld FNr muss null sein.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forderung" } } } }, "responses": { "201": { "description": "Die neu erstellte Forderung", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forderung" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Forderungen/{akteId}": { "description": "Forderungen/{akteId:int?}", "get": { "tags": [ "Forderungen" ], "summary": "Gibt eine Liste von Forderungen zu der Akte mit Aktennummer {nr} zurück (All)", "description": "**Valid roles:** All
", "operationId": "CfForderungenGet", "responses": { "200": { "description": "Forderungsliste", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Forderung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Freifelder": { "description": "Freifelder", "get": { "tags": [ "Freifelder" ], "summary": "Liste der vorgeschlagenen Werte der Freifelder auf Akte (Seite 3) (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetFreifelder", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Freifeld" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/FreifelderOptionen": { "description": "FreifelderOptionen", "get": { "tags": [ "FreifelderOptionen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetFrelfelderOptionen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FreifeldAkt2" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/FristArten": { "description": "FristArten", "get": { "tags": [ "FristArten" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetFristArten", "responses": { "200": { "description": "Fristartenliste", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FristArt" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/History": { "description": "History", "get": { "tags": [ "History" ], "summary": "Daten zur Aktengeschichte zu einer Akte oder zu einem Eintrag der Aktengeschichte ausgeben (All)", "description": "**Valid roles:** All
Genau ein Parameter (nr oder hnr) muss angegeben werden", "operationId": "CfHistoryGet", "parameters": [ { "name": "nr", "in": "query", "description": "Aktennummer", "schema": { "type": "integer", "format": "int32" } }, { "name": "hnr", "in": "query", "description": "Nummer des Aktengeschichteeintrags", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Liste mit Aktengeschichteeinträgen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryEntry" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "History" ], "summary": "Aktengeschichteeintrag in einer Akte anlegen (All)", "description": "**Valid roles:** All
", "operationId": "CfAddHistory", "requestBody": { "description": "Feld HNr wird ignoriert. Bei der Anlage wird eine neue Id generiert.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryEntryAdd" } } } }, "responses": { "201": { "description": "Id des neuen Eintrags", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdParam" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/HistoryTree": { "description": "HistoryTree", "post": { "tags": [ "HistoryTree" ], "summary": "Ordnet einen Aktengeschichteeintrag einem Ordner zu. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddHistoryTree", "requestBody": { "description": "Ordnernummer, Aktennummer und Nummer des Aktengeschichteeintrags", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryTreeParams" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryTreeParams" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Honorarzeiten": { "description": "Honorarzeiten", "get": { "tags": [ "Honorarzeiten" ], "summary": "Alle Honorarzeiten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetHonorarzeiten", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/Zeiterfassung" } } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Honorarzeiten" ], "summary": "Erstellt einen Datensatz für Honorarzeiten. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddHonorarzeiten", "requestBody": { "description": "Zeiterfassungsdatensatz", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZeiterfassungParameter" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/Zeiterfassung" } } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Honorarzeiten/{honorarzeitId}": { "description": "Honorarzeiten/{honorarzeitId:int}", "get": { "tags": [ "Honorarzeiten" ], "summary": "Honorarzeiten-Daten zu der angegebenen Id. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetHonorarzeitenById", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Zeiterfassung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "honorarzeitId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Kontaktperson": { "description": "Kontaktperson", "post": { "tags": [ "Kontaktperson" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddKontaktpersonAlt", "parameters": [ { "name": "Daten zur Kontaktperson", "in": "query", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/KontaktpersonParameterMitBetNr" } } ], "responses": { "201": { "description": "Daten zur Kontaktperson", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Kontaktperson" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/KontaktpersonBezeichnungen": { "description": "KontaktpersonBezeichnungen", "get": { "tags": [ "KontaktpersonBezeichnungen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetKontaktpersonBezeichnungen", "responses": { "200": { "description": "Liste der Bezeichnungen", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/KontaktpersonStellungen": { "description": "KontaktpersonStellungen", "get": { "tags": [ "KontaktpersonStellungen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetKontaktpersonStellungen", "responses": { "200": { "description": "Liste der Stellungen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Stellung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Listen/Anreden": { "description": "Listen/Anreden", "get": { "tags": [ "Listen" ], "summary": "Liefert eine Liste mit Anreden und Briefanreden (All)", "description": "**Valid roles:** All
", "operationId": "CfGetAnreden", "responses": { "200": { "description": "Die Anreden, Briefanreden", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Anrede" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/FreifelderOptionen": { "description": "Listen/FreifelderOptionen", "get": { "tags": [ "Listen" ], "summary": "Liste der Grundeinstellungen für die Freifelder (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeFreifelderOptionen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FreifeldAkt2" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/Fristen": { "description": "Listen/Fristen", "get": { "tags": [ "Listen" ], "summary": "Gibt eine Liste der Fristarten zurück. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeFristenarten", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FristArt" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/KontaktpersonBezeichnungen": { "description": "Listen/KontaktpersonBezeichnungen", "get": { "tags": [ "Listen" ], "summary": "Liste der Bezeichnungen für Kontaktpersonen. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeKontaktpersonBezeichnungen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/KontaktpersonStellungen": { "description": "Listen/KontaktpersonStellungen", "get": { "tags": [ "Listen" ], "summary": "Liste der Positionen (Stellungen) für Kontaktpersonen. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeKontaktpersonStellungen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Stellung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/PostausgangsStatus": { "description": "Listen/PostausgangsStatus", "get": { "tags": [ "Listen" ], "summary": "Liste der Postausgangsstatus (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListePostausgangsStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Versendungsart" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/Rechtsformen": { "description": "Listen/Rechtsformen", "get": { "tags": [ "Listen" ], "summary": "In Advoware definierte Rechtsformen (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeRechtsformen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rechtsform" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/Referate": { "description": "Listen/Referate", "get": { "tags": [ "Listen" ], "summary": "Liste der Referate (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeReferate", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReferatBase" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/Versendearten": { "description": "Listen/Versendearten", "get": { "tags": [ "Listen" ], "summary": "Liste der Versendearten (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeVersendearten", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Versendungsart" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/Vorgangstexte": { "description": "Listen/Vorgangstexte", "get": { "tags": [ "Listen" ], "summary": "Liste der Vorgangstexte (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeVorgangstexte", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vorgang" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Listen/Wegen": { "description": "Listen/Wegen", "get": { "tags": [ "Listen" ], "summary": "Liste der mögliche Werte für Wegen in einer Akte (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetListeWegen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Wegen" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/MessageStatus": { "description": "MessageStatus", "put": { "tags": [ "MessageStatus" ], "summary": "Metadaten für eine einzelne Nachricht oder für alle Nachrichten einer Konversation für den angemeldeten Mitarbeiter ändern. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
Pushnachricht für das Update der Badges wird ebenfalls geschickt, falls notwendig.", "operationId": "CfPutMessageStatus", "requestBody": { "description": "Metadaten. Die Felder Empfange, Gelesen, Geloescht, Flags sind optional.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageStatus" } } } }, "responses": { "200": { "description": "true, wenn sich der Status mindestens einer Nachricht geändert hat.", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Mitarbeiter": { "description": "Mitarbeiter", "get": { "tags": [ "Mitarbeiter" ], "summary": "Liste von Mitarbeitern, die die Kriterien erfüllen. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetMitarbeiter", "parameters": [ { "name": "aktiv", "in": "query", "description": "true: werden nur aktive Mitarbeiter zurückgegeben", "schema": { "type": "boolean" } }, { "name": "nachrichten", "in": "query", "description": "true: werden Mitarbeiter zurückgegeben, die das Nachrichtensystem nutzen", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Mitarbeiterliste", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Mitarbeiter" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/MitarbeiterNr/{Kuerzel}": { "description": "MitarbeiterNr/{Kuerzel}", "get": { "tags": [ "MitarbeiterNr" ], "summary": "Mitarbeiternummer aus dem Kürzel ermitteln. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetMitarbeiterNr", "responses": { "200": { "description": "Mitarbeiternummer", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "Kuerzel", "in": "path", "description": "Mitrbeiterkürzel", "required": true, "schema": { "type": "string" } } ] }, "/api/v1/advonet/NewActivities": { "description": "NewActivities", "get": { "tags": [ "NewActivities" ], "summary": "Liste der neuen Aktivitäten (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetNewActivities", "parameters": [ { "name": "table", "in": "query", "description": "Wenn gesetzt, werden nur Aktivitäten aus dieser Tabelle zurückgegeben", "schema": { "type": "string" } }, { "name": "includeFetched", "in": "query", "description": "True: Es werden auch Aktivitäten die als fetched markiert sind zurückgegeben", "schema": { "type": "boolean" } }, { "name": "fetched", "in": "query", "description": "Gibt nur Aktivitäten zurück die an oder nach diesem Zeitpunkt als fetched markiert wurden", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Liste der Aktivitäten", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewActivity" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "put": { "tags": [ "NewActivities" ], "summary": "Neue Aktivitäten auf erledigt setzen (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPutNewActivities", "parameters": [ { "name": "NewActivityNrs", "in": "query", "description": "Liste der IDs der neuen Aktivitäten", "required": true, "schema": { "$ref": "#/components/schemas/NewActivityFetchedParams" } } ], "responses": { "200": { "description": "Liste der Aktivitäten", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Ordner/{akteId}": { "description": "Ordner/{akteId:int:length(10)}", "get": { "tags": [ "Ordner" ], "summary": "Gibt die Ordnerstruktur der Aktengeschichte für eine Akte zurück. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetOrdner", "responses": { "200": { "description": "Ordnerstruktur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ordner" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Ordner/{akteId}/{beteiligterId}": { "description": "Ordner/{akteId:int:length(10)}/{beteiligterId:int}", "get": { "tags": [ "Ordner" ], "summary": "Gibt die Ordnerstruktur der Aktengeschichte für eine Akte zurück und einen Beteiligten. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetOrdnerForBet", "responses": { "200": { "description": "Ordnerstruktur", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ordner" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "akteId", "in": "path", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "beteiligterId", "in": "path", "description": "Beteiligtennummer", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/PaymentProviderInvoice": { "description": "PaymentProviderInvoice", "post": { "tags": [ "PaymentProviderInvoice" ], "summary": "Erstellt eine Zahlungsaufforderung und gibt bei erfolg ein Objekt zurück, das die Metadaten dieser Zahlungsaufforderung enthält (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPostPaymentProviderInvoice", "requestBody": { "description": "Objekt mit den benötigten Daten um die Zahlungsaufforderung zu erstellen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequest" } } } }, "responses": { "201": { "description": "Objekt mit Zahlungsaufforderungmetadaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResultResult" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/PaymentProviderInvoice/{invoiceId}": { "description": "PaymentProviderInvoice/{invoiceId:int}", "get": { "tags": [ "PaymentProviderInvoice" ], "summary": "Gibt ein Objekt mit Metadateen zu einer Zahlungsaufforderung mit der gegebenen Id zurück. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetPaymenProviderInvoice", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResultResult" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "invoiceId", "in": "path", "description": "Die Id der angefragten Zahlungsaufforderung.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Postausgang": { "description": "Postausgang", "post": { "tags": [ "Postausgang" ], "summary": "Ein Aktengeschichteeintrag wird im Postausgang eines Mitarbeiters oder mehrerer Mitarbeiter sichtbar gemacht. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddPostausgang", "requestBody": { "description": "Id des Aktengeschichteintrags, Mitarbeiter-Id(s) und Flag Posteingang / -ausgang", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VorgelegtParams" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VorgelegtParams" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/PostausgangsStati": { "description": "PostausgangsStati", "get": { "tags": [ "PostausgangsStati" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
Zukünftig PostausgangsStatus verwenden", "operationId": "CfGetPostausgangsStati", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Versendungsart" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/PostausgangsStatus": { "description": "PostausgangsStatus", "get": { "tags": [ "PostausgangsStatus" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetPostausgangsStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Versendungsart" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Posteingang": { "description": "Posteingang", "get": { "tags": [ "Posteingang" ], "summary": "Liste der Einträge im Posteingang für den Mitarbeiter im Token (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetPosteingang", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboxEntry" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Posteingang" ], "summary": "Ein Aktengeschichteeintrag wird im Posteingang eines Mitarbeiters oder mehrerer Mitarbeiter sichtbar gemacht. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddPosteingang", "requestBody": { "description": "Id des Aktengeschichteintrags, Mitarbeiter-Id(s) und Flag Posteingang / -ausgang", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VorgelegtParams" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VorgelegtParams" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Posteingang/{maId}": { "description": "Posteingang/{maId:int}", "get": { "tags": [ "Posteingang" ], "summary": "Liste der Einträge im Posteingang für die MitarbeiterId (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetPosteingangForMA", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboxEntry" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "maId", "in": "path", "description": "MitarbeiterId", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Rechnungen": { "description": "Rechnungen", "get": { "tags": [ "Rechnungen" ], "summary": "Erstellt eine Liste von Rechnungen (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetRechnungen", "parameters": [ { "name": "von", "in": "query", "description": "Ab Datum / Uhrzeit der Rechnungsstellung", "schema": { "type": "string", "format": "date-time" } }, { "name": "bis", "in": "query", "description": "Bis Datum / Uhrzeit der Rechnungsstellung", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Liste der gefundenen Rechnungen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rechnung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Rechnungen" ], "summary": "Erstellt eine neue Rechnung (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfNewRechnungen", "requestBody": { "description": "Rechnungsdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechnungParameter" } } } }, "responses": { "201": { "description": "Rückgabe des angelegten Datensatzes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rechnung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Rechnungen/{id}": { "description": "Rechnungen/{id:int}", "get": { "tags": [ "Rechnungen" ], "summary": "Erstellt eine Liste von Rechnungen (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetOneRechnung", "responses": { "200": { "description": "Rückgabe des geänderten Datensatzes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rechnung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Rechnungen/{rechnungId}": { "description": "Rechnungen/{rechnungId:int}", "put": { "tags": [ "Rechnungen" ], "summary": "Aktualisiert eine Rechnung (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfPutRechnungen", "requestBody": { "description": "Rechnungsdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechnungParameter" } } } }, "responses": { "200": { "description": "Rückgabe des geänderten Datensatzes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rechnung" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "parameters": [ { "name": "rechnungId", "in": "path", "description": "Rechnungs-ID (KNR)", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "/api/v1/advonet/Rechtsformen": { "description": "Rechtsformen", "get": { "tags": [ "Rechtsformen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetRechtsformen", "responses": { "200": { "description": "Liste der Rechtsformen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Rechtsform" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/RefData2": { "description": "RefData2", "get": { "tags": [ "RefData2" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfRefData2GetOld", "parameters": [ { "name": "Akte", "in": "query", "description": "Aktennummer", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Tabellenname", "in": "query", "description": "Name der Tabelle mit den Daten", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Generisches Dictionary", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true }, "put": { "tags": [ "RefData2" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfRefData2Put", "requestBody": { "description": "Generisches Dictionary angepasst an die Tabellenstruktur des Referats. Spezielle Einträge: \"NR\": Aktenummer, \"Tabelle\": Tabellenname des Referats", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "200": { "description": "true, wenn für die Akte noch keine Daten gespeichert waren. false, wenn vorhandene Daten überschrieben wurden.", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Referate": { "description": "Referate", "get": { "tags": [ "Referate" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetReferate", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReferatBase" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Statistiken/Akten": { "description": "Statistiken/Akten", "get": { "tags": [ "Statistiken" ], "summary": "Anzahl Akten pro Jahr, Referat, Mitarbeiter (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetStatistikenAktenAnzahl", "parameters": [ { "name": "yearFrom", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "yearTo", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnzahlRefMitarbeiter" } } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Statistiken/Umsaetze": { "description": "Statistiken/Umsaetze", "get": { "tags": [ "Statistiken" ], "summary": "Umsätze pro Jahr, Referat, Mitarbeiter (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetStatistikenUmsaetze", "parameters": [ { "name": "yearFrom", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "yearTo", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UmsatzRefMitarbeiter" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Termine": { "description": "Termine", "get": { "tags": [ "Termine" ], "summary": "Erstellt eine Listen von Terminen, die den Auswahlkriterien entsprechen. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetTermine", "parameters": [ { "name": "frnr", "in": "query", "description": "Nummer des Termins", "schema": { "type": "integer", "format": "int32" } }, { "name": "nr", "in": "query", "description": "Aktennummer des Termins", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "Startzeitpunkt - muss immer zusamen mit dem Endzeitpunkt angegeben werden.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "Endzeitpunkt - muss immer zusamen mit dem Startzeitpunkt angegeben werden.", "schema": { "type": "string", "format": "date-time" } }, { "name": "kuerzel", "in": "query", "description": "Optionales Mitarbeiterkuerzel. Wenn nicht angegeben, werden Termine für den angemeldeten Mitarbeiter gesucht.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Liste von Terminen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Termin" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "put": { "tags": [ "Termine" ], "summary": "Ändert einen bestehenden Termin. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfMmodifyTermin", "requestBody": { "description": "Termindaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Termin" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Termin" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Termine" ], "summary": "Legt einen neuen Termin an. Das Feld frnr in den Eingabedaten wird ignoriert. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfAddTermin", "requestBody": { "description": "Termindaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Termin" } } } }, "responses": { "201": { "description": "Id des neuen Termins", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FristenNr" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "delete": { "tags": [ "Termine" ], "summary": "Löscht einen Termin. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfDeleteTermin", "parameters": [ { "name": "frnr", "in": "query", "description": "Nummer des Termins", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/TermineMitarbeiter": { "description": "TermineMitarbeiter", "get": { "tags": [ "TermineMitarbeiter" ], "summary": "List der Mitarbeiter, die die Berechtigung haben, Termine zu bearbeiten. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetTermineMitarbeiter", "responses": { "200": { "description": "Mitarbeiterliste", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Mitarbeiter" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Todos": { "description": "Todos", "get": { "tags": [ "Todos" ], "summary": "Gibt eine Liste von Fristen zurück, die den Suchkriterien entsprechen. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetTodos", "parameters": [ { "name": "frnr", "in": "query", "description": "Nummer der Frist. Wenn angegeben, werden die anderen Suchkriterien ignoriert.", "schema": { "type": "integer", "format": "int32" } }, { "name": "nr", "in": "query", "description": "Aktennummer der Fristen", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Optionaler Status der Frist", "schema": { "type": "string" } }, { "name": "showDone", "in": "query", "description": "Erledigte Fristen auswählen", "schema": { "type": "boolean" } }, { "name": "from", "in": "query", "description": "Startzeitpunkt - muss immer zusamen mit dem Endzeitpunkt angegeben werden.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "Endzeitpunkt - muss immer zusamen mit dem Startzeitpunkt angegeben werden.", "schema": { "type": "string", "format": "date-time" } }, { "name": "kuerzel", "in": "query", "description": "Optionales Mitarbeiterkürzel. Wenn nicht angegeben, werden Fristen für den angemeldeten Mitarbeiter gesucht.", "schema": { "type": "string" } }, { "name": "showPoolTasks", "in": "query", "description": "Fristen, die dem Pool zugeordnet sind, werden auch ausgewählt.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Liste von Fristen", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Frist" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "put": { "tags": [ "Todos" ], "summary": "Ändert eine bestehende Frist (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfMmodifyTodo", "requestBody": { "description": "Fristdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FristN" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FristN" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "post": { "tags": [ "Todos" ], "summary": "Erstellt eine neue Frist. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfAddTodo", "requestBody": { "description": "Fristdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FristN" } } } }, "responses": { "201": { "description": "Id der neuen Frist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FristenNr" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } }, "delete": { "tags": [ "Todos" ], "summary": "Löscht eine Frist. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfDeleteTodo", "parameters": [ { "name": "frnr", "in": "query", "description": "Nummer der Frist", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "Die Ressource wurde gelöscht, falls vorhanden." }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/UnreadChatMessageCount": { "description": "UnreadChatMessageCount", "get": { "tags": [ "UnreadChatMessageCount" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetUnreadChatMessageCountAlt", "responses": { "200": { "description": "Nachrichtenanzahl", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/User": { "description": "User", "get": { "tags": [ "User" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfCheckLoginAlt", "responses": { "200": { "description": "Nutzerdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityLoggedIn" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Users": { "description": "Users", "get": { "tags": [ "Users" ], "summary": "Identität des eingeloggten Users (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfCheckLogin", "responses": { "200": { "description": "Nutzerdaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityLoggedIn" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Users/UnreadChatMessageCount": { "description": "Users/UnreadChatMessageCount", "get": { "tags": [ "Users" ], "summary": "Gesamtzahl der ungelesenen Nachrichten für den angemeldeten Mitarbeiter zurückgeben. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfGetUnreadChatMessageCount", "responses": { "200": { "description": "Nachrichtenanzahl", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Versendearten": { "description": "Versendearten", "get": { "tags": [ "Versendearten" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetVersendearten", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Versendungsart" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Vorgaenge": { "description": "Vorgaenge", "get": { "tags": [ "Vorgaenge" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetVorgaenge", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Vorgang" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Vorgelegt": { "description": "Vorgelegt", "post": { "tags": [ "Vorgelegt" ], "summary": "Ein Aktengeschichteeintrag wird im Posteingang eines Mitarbeiters sichtbar gemacht. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfAddVorgelegt", "requestBody": { "description": "Id des Aktengeschichteintrags, Mitarbeiter-Id(s) und Flag Posteingang / -ausgang", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VorgelegtParams" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VorgelegtParams" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } }, "/api/v1/advonet/Wegen": { "description": "Wegen", "get": { "tags": [ "Wegen" ], "summary": "Seit dem 11.01.2023 nicht mehr unterstützt. (AllLoggedIn)", "description": "**Valid roles:** AllLoggedIn
", "operationId": "CfGetWegen", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Wegen" } } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "404": { "description": "Die Ressource wurde nicht gefunden.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } }, "deprecated": true } }, "/api/v1/advonet/Wiedervorlagen": { "description": "Wiedervorlagen", "post": { "tags": [ "Wiedervorlagen" ], "summary": "Erstellt eine neue Wiedervorlage. (Mitarbeiter)", "description": "**Valid roles:** Mitarbeiter
", "operationId": "CfAddWiedervorlage", "requestBody": { "description": "Wiedervorlagedaten", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WiedervorlageParameter" } } } }, "responses": { "201": { "description": "Wiedervorlage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wiedervorlage" } } } }, "400": { "description": "Fehlende oder fehlerhafte Aufrufparameter.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "401": { "description": "Ungültige Zugangsdaten.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "403": { "description": "Der Benutzer hat keine Berechtigung, die Operation auszuführen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } }, "500": { "description": "Eine Ausnahme wurde beim Ausführen der Operation geworfen.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fehlerbeschreibung" } } } } } } }, "components": { "schemas": { "Adresse": { "type": "object", "properties": { "strasse": { "maxLength": 50, "type": "string", "nullable": true }, "plz": { "maxLength": 20, "type": "string", "nullable": true }, "ort": { "maxLength": 39, "type": "string", "nullable": true }, "land": { "maxLength": 3, "type": "string", "nullable": true }, "postfach": { "maxLength": 20, "type": "string", "nullable": true }, "postfachPLZ": { "maxLength": 6, "type": "string", "nullable": true }, "anschrift": { "maxLength": 250, "type": "string", "nullable": true }, "standardAnschrift": { "type": "boolean" }, "bemerkung": { "maxLength": 250, "type": "string", "nullable": true }, "gueltigVon": { "type": "string", "format": "date-time", "nullable": true }, "gueltigBis": { "type": "string", "format": "date-time", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "beteiligterId": { "type": "integer", "format": "int32" }, "reihenfolgeIndex": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AdresseParameter": { "type": "object", "properties": { "strasse": { "maxLength": 50, "type": "string", "nullable": true }, "plz": { "maxLength": 20, "type": "string", "nullable": true }, "ort": { "maxLength": 39, "type": "string", "nullable": true }, "land": { "maxLength": 3, "type": "string", "nullable": true }, "postfach": { "maxLength": 20, "type": "string", "nullable": true }, "postfachPLZ": { "maxLength": 6, "type": "string", "nullable": true }, "anschrift": { "maxLength": 250, "type": "string", "nullable": true }, "standardAnschrift": { "type": "boolean" }, "bemerkung": { "maxLength": 250, "type": "string", "nullable": true }, "gueltigVon": { "type": "string", "format": "date-time", "nullable": true }, "gueltigBis": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Akte": { "type": "object", "properties": { "rubrum": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "wegen": { "type": "string", "nullable": true }, "ablage": { "type": "integer", "format": "int32", "nullable": true }, "abgelegt": { "type": "string", "format": "date-time", "nullable": true }, "angelegt": { "type": "string", "format": "date-time", "nullable": true }, "wert": { "type": "number", "format": "double", "nullable": true }, "sb": { "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "vstab": { "$ref": "#/components/schemas/Vstab" }, "mBez": { "type": "string", "nullable": true }, "gBez": { "type": "string", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "aFrei1": { "type": "string", "nullable": true }, "aFrei2": { "type": "string", "nullable": true }, "aFrei3": { "type": "string", "nullable": true }, "aFrei4": { "type": "string", "nullable": true }, "aFrei5": { "type": "string", "nullable": true }, "aFrei6": { "type": "string", "nullable": true }, "aFrei7": { "type": "string", "nullable": true }, "aFrei8": { "type": "string", "nullable": true }, "aFrei9": { "type": "string", "nullable": true }, "aFrei10": { "type": "string", "nullable": true }, "rvg": { "type": "integer", "format": "int32", "nullable": true }, "referatLang": { "type": "string", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "az": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AkteBase": { "type": "object", "properties": { "rowId": { "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "az": { "type": "string", "nullable": true }, "rubrum": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "wegen": { "type": "string", "nullable": true }, "ablage": { "type": "integer", "format": "int32", "nullable": true }, "abgelegt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AkteComplex": { "type": "object", "properties": { "rubrum": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "wegen": { "type": "string", "nullable": true }, "ablage": { "type": "integer", "format": "int32", "nullable": true }, "abgelegt": { "type": "string", "format": "date-time", "nullable": true }, "angelegt": { "type": "string", "format": "date-time", "nullable": true }, "wert": { "type": "number", "format": "double", "nullable": true }, "sb": { "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "vstab": { "$ref": "#/components/schemas/Vstab" }, "mBez": { "type": "string", "nullable": true }, "gBez": { "type": "string", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "aFrei1": { "type": "string", "nullable": true }, "aFrei2": { "type": "string", "nullable": true }, "aFrei3": { "type": "string", "nullable": true }, "aFrei4": { "type": "string", "nullable": true }, "aFrei5": { "type": "string", "nullable": true }, "aFrei6": { "type": "string", "nullable": true }, "aFrei7": { "type": "string", "nullable": true }, "aFrei8": { "type": "string", "nullable": true }, "aFrei9": { "type": "string", "nullable": true }, "aFrei10": { "type": "string", "nullable": true }, "rvg": { "type": "integer", "format": "int32", "nullable": true }, "referatLang": { "type": "string", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "az": { "type": "string", "nullable": true }, "termine": { "type": "array", "items": { "$ref": "#/components/schemas/Termin" }, "nullable": true }, "fristen": { "type": "array", "items": { "$ref": "#/components/schemas/Frist" }, "nullable": true }, "betakt": { "type": "array", "items": { "$ref": "#/components/schemas/BetAkt" }, "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryEntry" }, "nullable": true }, "ordner": { "type": "array", "items": { "$ref": "#/components/schemas/Ordner" }, "nullable": true } }, "additionalProperties": false }, "AkteParameter": { "type": "object", "properties": { "rubrum": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "wegen": { "type": "string", "nullable": true }, "ablage": { "type": "integer", "format": "int32", "nullable": true }, "abgelegt": { "type": "string", "format": "date-time", "nullable": true }, "angelegt": { "type": "string", "format": "date-time", "nullable": true }, "wert": { "type": "number", "format": "double", "nullable": true }, "sb": { "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "vstab": { "$ref": "#/components/schemas/Vstab" }, "mBez": { "type": "string", "nullable": true }, "gBez": { "type": "string", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "aFrei1": { "type": "string", "nullable": true }, "aFrei2": { "type": "string", "nullable": true }, "aFrei3": { "type": "string", "nullable": true }, "aFrei4": { "type": "string", "nullable": true }, "aFrei5": { "type": "string", "nullable": true }, "aFrei6": { "type": "string", "nullable": true }, "aFrei7": { "type": "string", "nullable": true }, "aFrei8": { "type": "string", "nullable": true }, "aFrei9": { "type": "string", "nullable": true }, "aFrei10": { "type": "string", "nullable": true }, "rvg": { "type": "integer", "format": "int32", "nullable": true }, "referatLang": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AktenHonorarSaldo": { "type": "object", "properties": { "saldo": { "type": "number", "format": "double", "nullable": true }, "sollstellungen": { "type": "number", "format": "double", "nullable": true }, "zahlungen": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Aktennummer": { "type": "object", "properties": { "nr": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Anrede": { "type": "object", "properties": { "anredeText": { "maxLength": 35, "type": "string", "nullable": true }, "briefAnrede": { "maxLength": 70, "type": "string", "nullable": true } }, "additionalProperties": false }, "AnzahlRefMitarbeiter": { "type": "object", "properties": { "mitarbeiterKuerzel": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "jahr": { "type": "integer", "format": "int32" }, "anzahl": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bankverbindung": { "type": "object", "properties": { "bank": { "maxLength": 100, "type": "string", "nullable": true }, "ktoNr": { "maxLength": 254, "type": "string", "nullable": true }, "blz": { "maxLength": 20, "type": "string", "nullable": true }, "iban": { "maxLength": 254, "type": "string", "nullable": true }, "bic": { "maxLength": 12, "type": "string", "nullable": true }, "kontoinhaber": { "maxLength": 80, "type": "string", "nullable": true }, "mandatsreferenz": { "maxLength": 35, "type": "string", "nullable": true }, "mandatVom": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BankverbindungParameter": { "type": "object", "properties": { "bank": { "maxLength": 100, "type": "string", "nullable": true }, "ktoNr": { "maxLength": 254, "type": "string", "nullable": true }, "blz": { "maxLength": 20, "type": "string", "nullable": true }, "iban": { "maxLength": 254, "type": "string", "nullable": true }, "bic": { "maxLength": 12, "type": "string", "nullable": true }, "kontoinhaber": { "maxLength": 80, "type": "string", "nullable": true }, "mandatsreferenz": { "maxLength": 35, "type": "string", "nullable": true }, "mandatVom": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BetAkt": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "art": { "type": "string", "nullable": true }, "stellung": { "type": "string", "nullable": true }, "betreff": { "type": "string", "nullable": true }, "betreff2": { "type": "string", "nullable": true }, "betreff3": { "type": "string", "nullable": true }, "kz": { "type": "integer", "format": "int32", "nullable": true }, "ebene": { "type": "integer", "format": "int32", "nullable": true }, "lfd": { "type": "integer", "format": "int32", "nullable": true }, "master": { "type": "integer", "format": "int32", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" }, "beteiligter": { "$ref": "#/components/schemas/BeteiligterComplex" } }, "additionalProperties": false }, "BetAktMitNr": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "art": { "type": "string", "nullable": true }, "stellung": { "type": "string", "nullable": true }, "betreff": { "type": "string", "nullable": true }, "betreff2": { "type": "string", "nullable": true }, "betreff3": { "type": "string", "nullable": true }, "kz": { "type": "integer", "format": "int32", "nullable": true }, "ebene": { "type": "integer", "format": "int32", "nullable": true }, "lfd": { "type": "integer", "format": "int32", "nullable": true }, "master": { "type": "integer", "format": "int32", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BetAktParameter": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "art": { "type": "string", "nullable": true }, "stellung": { "type": "string", "nullable": true }, "betreff": { "type": "string", "nullable": true }, "betreff2": { "type": "string", "nullable": true }, "betreff3": { "type": "string", "nullable": true }, "kz": { "type": "integer", "format": "int32", "nullable": true }, "ebene": { "type": "integer", "format": "int32", "nullable": true }, "lfd": { "type": "integer", "format": "int32", "nullable": true }, "master": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BetIns": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "ug": { "type": "string", "nullable": true }, "notariat": { "type": "integer", "format": "int32" }, "erschienene": { "type": "string", "nullable": true }, "gericht": { "type": "integer", "format": "int32" }, "advoNet": { "type": "integer", "format": "int32" }, "versicherung": { "type": "integer", "format": "int32" }, "zeitHonorar": { "type": "integer", "format": "int32" }, "kollisionspruefung": { "type": "integer", "format": "int32" }, "kategorie": { "type": "string", "nullable": true }, "anwalt": { "type": "integer", "format": "int32" }, "ordnerNr": { "type": "integer", "format": "int32" }, "mandantenSaldo": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BetInsParameter": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "ug": { "type": "string", "nullable": true }, "notariat": { "type": "integer", "format": "int32" }, "erschienene": { "type": "string", "nullable": true }, "gericht": { "type": "integer", "format": "int32" }, "advoNet": { "type": "integer", "format": "int32" }, "versicherung": { "type": "integer", "format": "int32" }, "zeitHonorar": { "type": "integer", "format": "int32" }, "kollisionspruefung": { "type": "integer", "format": "int32" }, "kategorie": { "type": "string", "nullable": true }, "anwalt": { "type": "integer", "format": "int32" }, "ordnerNr": { "type": "integer", "format": "int32" }, "mandantenSaldo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BeteiligteNrParam": { "type": "object", "properties": { "betnr": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Beteiligter": { "type": "object", "properties": { "anschrift": { "type": "string", "nullable": true, "deprecated": true }, "strasse": { "type": "string", "nullable": true, "deprecated": true }, "plz": { "type": "string", "nullable": true, "deprecated": true }, "ort": { "type": "string", "nullable": true, "deprecated": true }, "email": { "type": "string", "nullable": true, "deprecated": true }, "emailGesch": { "type": "string", "nullable": true, "deprecated": true }, "mobil": { "type": "string", "nullable": true, "deprecated": true }, "internet": { "type": "string", "nullable": true, "deprecated": true }, "telGesch": { "type": "string", "nullable": true, "deprecated": true }, "telPrivat": { "type": "string", "nullable": true, "deprecated": true }, "faxGesch": { "type": "string", "nullable": true, "deprecated": true }, "faxPrivat": { "type": "string", "nullable": true, "deprecated": true }, "autotelefon": { "type": "string", "nullable": true, "deprecated": true }, "sonstige": { "type": "string", "nullable": true, "deprecated": true }, "ePost": { "type": "string", "nullable": true, "deprecated": true }, "bea": { "type": "string", "nullable": true, "deprecated": true }, "art": { "type": "string", "nullable": true }, "vorname": { "maxLength": 30, "type": "string", "nullable": true }, "name": { "maxLength": 140, "type": "string", "nullable": true }, "kurzname": { "maxLength": 20, "type": "string", "nullable": true }, "geburtsname": { "maxLength": 100, "type": "string", "nullable": true }, "familienstand": { "maxLength": 30, "type": "string", "nullable": true }, "titel": { "maxLength": 50, "type": "string", "nullable": true }, "anrede": { "maxLength": 35, "type": "string", "nullable": true }, "bAnrede": { "maxLength": 150, "type": "string", "nullable": true }, "geburtsdatum": { "type": "string", "format": "date-time", "nullable": true }, "sterbedatum": { "type": "string", "format": "date-time", "nullable": true }, "zusatz": { "maxLength": 100, "type": "string", "nullable": true }, "rechtsform": { "maxLength": 50, "type": "string", "nullable": true }, "geaendertAm": { "type": "string", "format": "date-time", "nullable": true }, "geaendertVon": { "maxLength": 4, "type": "string", "nullable": true }, "angelegtAm": { "type": "string", "format": "date-time", "nullable": true }, "angelegtVon": { "maxLength": 4, "type": "string", "nullable": true }, "handelsRegisterNummer": { "maxLength": 50, "type": "string", "nullable": true }, "registergericht": { "maxLength": 50, "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BeteiligterComplex": { "type": "object", "properties": { "anschrift": { "type": "string", "nullable": true, "deprecated": true }, "strasse": { "type": "string", "nullable": true, "deprecated": true }, "plz": { "type": "string", "nullable": true, "deprecated": true }, "ort": { "type": "string", "nullable": true, "deprecated": true }, "email": { "type": "string", "nullable": true, "deprecated": true }, "emailGesch": { "type": "string", "nullable": true, "deprecated": true }, "mobil": { "type": "string", "nullable": true, "deprecated": true }, "internet": { "type": "string", "nullable": true, "deprecated": true }, "telGesch": { "type": "string", "nullable": true, "deprecated": true }, "telPrivat": { "type": "string", "nullable": true, "deprecated": true }, "faxGesch": { "type": "string", "nullable": true, "deprecated": true }, "faxPrivat": { "type": "string", "nullable": true, "deprecated": true }, "autotelefon": { "type": "string", "nullable": true, "deprecated": true }, "sonstige": { "type": "string", "nullable": true, "deprecated": true }, "ePost": { "type": "string", "nullable": true, "deprecated": true }, "bea": { "type": "string", "nullable": true, "deprecated": true }, "art": { "type": "string", "nullable": true }, "vorname": { "maxLength": 30, "type": "string", "nullable": true }, "name": { "maxLength": 140, "type": "string", "nullable": true }, "kurzname": { "maxLength": 20, "type": "string", "nullable": true }, "geburtsname": { "maxLength": 100, "type": "string", "nullable": true }, "familienstand": { "maxLength": 30, "type": "string", "nullable": true }, "titel": { "maxLength": 50, "type": "string", "nullable": true }, "anrede": { "maxLength": 35, "type": "string", "nullable": true }, "bAnrede": { "maxLength": 150, "type": "string", "nullable": true }, "geburtsdatum": { "type": "string", "format": "date-time", "nullable": true }, "sterbedatum": { "type": "string", "format": "date-time", "nullable": true }, "zusatz": { "maxLength": 100, "type": "string", "nullable": true }, "rechtsform": { "maxLength": 50, "type": "string", "nullable": true }, "geaendertAm": { "type": "string", "format": "date-time", "nullable": true }, "geaendertVon": { "maxLength": 4, "type": "string", "nullable": true }, "angelegtAm": { "type": "string", "format": "date-time", "nullable": true }, "angelegtVon": { "maxLength": 4, "type": "string", "nullable": true }, "handelsRegisterNummer": { "maxLength": 50, "type": "string", "nullable": true }, "registergericht": { "maxLength": 50, "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "rowId": { "type": "string", "nullable": true }, "kommunikation": { "type": "array", "items": { "$ref": "#/components/schemas/Kommunikation" }, "nullable": true }, "kontaktpersonen": { "type": "array", "items": { "$ref": "#/components/schemas/Kontaktperson" }, "nullable": true }, "beteiligungen": { "type": "array", "items": { "$ref": "#/components/schemas/Beteiligung" }, "nullable": true }, "adressen": { "type": "array", "items": { "$ref": "#/components/schemas/Adresse" }, "nullable": true }, "bankkverbindungen": { "type": "array", "items": { "$ref": "#/components/schemas/Bankverbindung" }, "nullable": true } }, "additionalProperties": false }, "BeteiligterComplexBetNr": { "type": "object", "properties": { "anschrift": { "type": "string", "nullable": true, "deprecated": true }, "strasse": { "type": "string", "nullable": true, "deprecated": true }, "plz": { "type": "string", "nullable": true, "deprecated": true }, "ort": { "type": "string", "nullable": true, "deprecated": true }, "email": { "type": "string", "nullable": true, "deprecated": true }, "emailGesch": { "type": "string", "nullable": true, "deprecated": true }, "mobil": { "type": "string", "nullable": true, "deprecated": true }, "internet": { "type": "string", "nullable": true, "deprecated": true }, "telGesch": { "type": "string", "nullable": true, "deprecated": true }, "telPrivat": { "type": "string", "nullable": true, "deprecated": true }, "faxGesch": { "type": "string", "nullable": true, "deprecated": true }, "faxPrivat": { "type": "string", "nullable": true, "deprecated": true }, "autotelefon": { "type": "string", "nullable": true, "deprecated": true }, "sonstige": { "type": "string", "nullable": true, "deprecated": true }, "ePost": { "type": "string", "nullable": true, "deprecated": true }, "bea": { "type": "string", "nullable": true, "deprecated": true }, "art": { "type": "string", "nullable": true }, "vorname": { "maxLength": 30, "type": "string", "nullable": true }, "name": { "maxLength": 140, "type": "string", "nullable": true }, "kurzname": { "maxLength": 20, "type": "string", "nullable": true }, "geburtsname": { "maxLength": 100, "type": "string", "nullable": true }, "familienstand": { "maxLength": 30, "type": "string", "nullable": true }, "titel": { "maxLength": 50, "type": "string", "nullable": true }, "anrede": { "maxLength": 35, "type": "string", "nullable": true }, "bAnrede": { "maxLength": 150, "type": "string", "nullable": true }, "geburtsdatum": { "type": "string", "format": "date-time", "nullable": true }, "sterbedatum": { "type": "string", "format": "date-time", "nullable": true }, "zusatz": { "maxLength": 100, "type": "string", "nullable": true }, "rechtsform": { "maxLength": 50, "type": "string", "nullable": true }, "geaendertAm": { "type": "string", "format": "date-time", "nullable": true }, "geaendertVon": { "maxLength": 4, "type": "string", "nullable": true }, "angelegtAm": { "type": "string", "format": "date-time", "nullable": true }, "angelegtVon": { "maxLength": 4, "type": "string", "nullable": true }, "handelsRegisterNummer": { "maxLength": 50, "type": "string", "nullable": true }, "registergericht": { "maxLength": 50, "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "rowId": { "type": "string", "nullable": true }, "kommunikation": { "type": "array", "items": { "$ref": "#/components/schemas/Kommunikation" }, "nullable": true }, "kontaktpersonen": { "type": "array", "items": { "$ref": "#/components/schemas/Kontaktperson" }, "nullable": true }, "beteiligungen": { "type": "array", "items": { "$ref": "#/components/schemas/Beteiligung" }, "nullable": true }, "adressen": { "type": "array", "items": { "$ref": "#/components/schemas/Adresse" }, "nullable": true }, "bankkverbindungen": { "type": "array", "items": { "$ref": "#/components/schemas/Bankverbindung" }, "nullable": true }, "betNr": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BeteiligterParameter": { "type": "object", "properties": { "anschrift": { "type": "string", "nullable": true, "deprecated": true }, "strasse": { "type": "string", "nullable": true, "deprecated": true }, "plz": { "type": "string", "nullable": true, "deprecated": true }, "ort": { "type": "string", "nullable": true, "deprecated": true }, "email": { "type": "string", "nullable": true, "deprecated": true }, "emailGesch": { "type": "string", "nullable": true, "deprecated": true }, "mobil": { "type": "string", "nullable": true, "deprecated": true }, "internet": { "type": "string", "nullable": true, "deprecated": true }, "telGesch": { "type": "string", "nullable": true, "deprecated": true }, "telPrivat": { "type": "string", "nullable": true, "deprecated": true }, "faxGesch": { "type": "string", "nullable": true, "deprecated": true }, "faxPrivat": { "type": "string", "nullable": true, "deprecated": true }, "autotelefon": { "type": "string", "nullable": true, "deprecated": true }, "sonstige": { "type": "string", "nullable": true, "deprecated": true }, "ePost": { "type": "string", "nullable": true, "deprecated": true }, "bea": { "type": "string", "nullable": true, "deprecated": true }, "art": { "type": "string", "nullable": true }, "vorname": { "maxLength": 30, "type": "string", "nullable": true }, "name": { "maxLength": 140, "type": "string", "nullable": true }, "kurzname": { "maxLength": 20, "type": "string", "nullable": true }, "geburtsname": { "maxLength": 100, "type": "string", "nullable": true }, "familienstand": { "maxLength": 30, "type": "string", "nullable": true }, "titel": { "maxLength": 50, "type": "string", "nullable": true }, "anrede": { "maxLength": 35, "type": "string", "nullable": true }, "bAnrede": { "maxLength": 150, "type": "string", "nullable": true }, "geburtsdatum": { "type": "string", "format": "date-time", "nullable": true }, "sterbedatum": { "type": "string", "format": "date-time", "nullable": true }, "zusatz": { "maxLength": 100, "type": "string", "nullable": true }, "rechtsform": { "maxLength": 50, "type": "string", "nullable": true }, "geaendertAm": { "type": "string", "format": "date-time", "nullable": true }, "geaendertVon": { "maxLength": 4, "type": "string", "nullable": true }, "angelegtAm": { "type": "string", "format": "date-time", "nullable": true }, "angelegtVon": { "maxLength": 4, "type": "string", "nullable": true }, "handelsRegisterNummer": { "maxLength": 50, "type": "string", "nullable": true }, "registergericht": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "Beteiligung": { "type": "object", "properties": { "beteiligtenArt": { "type": "string", "nullable": true }, "akte": { "$ref": "#/components/schemas/AkteBase" }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Buchung": { "type": "object", "properties": { "rowId": { "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "bNr": { "type": "integer", "format": "int32" }, "fNr": { "type": "integer", "format": "int32" }, "fbNr": { "type": "integer", "format": "int32" }, "kNr": { "type": "integer", "format": "int32" }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "buchungsdatum": { "type": "string", "format": "date-time", "nullable": true }, "wertDatum": { "type": "string", "format": "date-time", "nullable": true }, "betrag": { "type": "number", "format": "double" }, "honorar": { "type": "number", "format": "double" }, "finanzkonto": { "maxLength": 9, "type": "string", "nullable": true }, "konto": { "maxLength": 6, "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "text2": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "referatLang": { "type": "string", "nullable": true }, "sb": { "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "fkNr": { "type": "integer", "format": "int32", "nullable": true }, "umsatzsteuerbetrag": { "type": "number", "format": "double", "nullable": true }, "umsatzsteuersatz": { "type": "number", "format": "double", "nullable": true }, "bgb367": { "type": "boolean", "nullable": true }, "sKonto": { "type": "string", "nullable": true }, "fremd": { "type": "number", "format": "double" }, "kuerzel": { "type": "string", "nullable": true }, "zweck": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Chat": { "type": "object", "properties": { "uId": { "type": "integer", "format": "int32" }, "ungelesene": { "type": "integer", "format": "int32" }, "besitzer": { "type": "integer", "format": "int32", "nullable": true }, "titel": { "type": "string", "nullable": true }, "akte": { "type": "integer", "format": "int32", "nullable": true }, "az": { "type": "string", "nullable": true }, "rubrum": { "type": "string", "nullable": true }, "akteAbgelegt": { "type": "string", "format": "date-time", "nullable": true }, "teilnehmer": { "type": "array", "items": { "$ref": "#/components/schemas/MitarbeiterBase" }, "nullable": true }, "nachrichten": { "type": "array", "items": { "$ref": "#/components/schemas/Nachricht" }, "nullable": true } }, "additionalProperties": false }, "ChatMessage": { "type": "object", "properties": { "akte": { "type": "integer", "format": "int32", "nullable": true }, "partner": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateInvoiceRequest": { "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "currency": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "purpose": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "format": "uuid" }, "sku": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "vatRate": { "type": "string", "nullable": true }, "paymentWebsiteName": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Error": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Feiertag": { "type": "object", "properties": { "tag": { "maxLength": 120, "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time" }, "standort": { "maxLength": 30, "type": "string", "nullable": true }, "individuell": { "type": "boolean" } }, "additionalProperties": false }, "FileAttributes": { "enum": [ 0, 1, 2, 4, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 131072 ], "type": "integer", "description": "\n\n0 = None\n\n1 = ReadOnly\n\n2 = Hidden\n\n4 = System\n\n16 = Directory\n\n32 = Archive\n\n64 = Device\n\n128 = Normal\n\n256 = Temporary\n\n512 = SparseFile\n\n1024 = ReparsePoint\n\n2048 = Compressed\n\n4096 = Offline\n\n8192 = NotContentIndexed\n\n16384 = Encrypted\n\n32768 = IntegrityStream\n\n131072 = NoScrubData", "format": "int32", "x-enumNames": [ "None", "ReadOnly", "Hidden", "System", "Directory", "Archive", "Device", "Normal", "Temporary", "SparseFile", "ReparsePoint", "Compressed", "Offline", "NotContentIndexed", "Encrypted", "IntegrityStream", "NoScrubData" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "FileHnr": { "type": "object", "properties": { "hnr": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FileInfos": { "type": "object", "properties": { "original": { "$ref": "#/components/schemas/Info" }, "generatedPdf": { "$ref": "#/components/schemas/Info" }, "preview": { "$ref": "#/components/schemas/Info" } }, "additionalProperties": false }, "Forderung": { "type": "object", "properties": { "nr": { "type": "integer", "format": "int32" }, "fNr": { "type": "integer", "format": "int32" }, "fkNr": { "type": "integer", "format": "int32" }, "bDatum": { "type": "string", "format": "date-time" }, "betrag": { "type": "number", "format": "double" }, "zins": { "type": "number", "format": "double" }, "zBeginn": { "type": "string", "format": "date-time" }, "zEnde": { "type": "string", "format": "date-time" }, "pEnde": { "type": "string", "format": "date-time" }, "text": { "type": "string", "nullable": true }, "art": { "type": "string", "nullable": true }, "turnus": { "type": "integer", "format": "int32" }, "turnusArt": { "type": "string", "nullable": true }, "foArt": { "type": "integer", "format": "int32" }, "zvNr": { "type": "integer", "format": "int32" }, "mNr": { "type": "integer", "format": "int32" }, "mini": { "type": "number", "format": "double" }, "maxi": { "type": "number", "format": "double" }, "vertragsdatum": { "type": "string", "format": "date-time" }, "vertragsgegenstand": { "type": "string", "nullable": true }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Freifeld": { "type": "object", "properties": { "nr": { "type": "integer", "format": "int32" }, "inhalt": { "maxLength": 254, "type": "string", "nullable": true }, "lfd": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FreifeldAkt2": { "type": "object", "properties": { "freifeldNr": { "maxLength": 2, "type": "integer", "format": "int32" }, "mussfeld": { "type": "boolean" }, "gesperrt": { "type": "boolean" } }, "additionalProperties": false }, "Frist": { "type": "object", "properties": { "rowId": { "type": "string", "nullable": true }, "datumBeginn": { "type": "string", "format": "date-time" }, "art": { "maxLength": 254, "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32" }, "text": { "maxLength": 254, "type": "string", "nullable": true }, "frNr": { "type": "integer", "format": "int32" }, "erledigt": { "maxLength": 1, "type": "string", "nullable": true }, "status": { "maxLength": 30, "type": "string", "nullable": true }, "anwaltLang": { "type": "string", "nullable": true }, "kuerzel": { "maxLength": 4, "type": "string", "nullable": true }, "sb": { "maxLength": 4, "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "vorfrist": { "type": "string", "format": "date-time" }, "notfrist": { "maxLength": 1, "type": "string", "nullable": true }, "adressat": { "type": "integer", "format": "int32" }, "master": { "type": "integer", "format": "int32" }, "erledigt_Datum": { "type": "string", "format": "date-time" }, "privat": { "maxLength": 1, "type": "string", "nullable": true }, "artNr": { "type": "integer", "format": "int32" }, "kz": { "type": "integer", "format": "int32" }, "prioritaet": { "maxLength": 25, "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time" }, "dauer": { "type": "string", "format": "date-span" }, "notizen": { "maxLength": 254, "type": "string", "nullable": true }, "hNr": { "type": "integer", "format": "int32" }, "gespraechspartner": { "maxLength": 170, "type": "string", "nullable": true }, "rufnummer": { "maxLength": 20, "type": "string", "nullable": true }, "zuletztGeaendertAm": { "type": "string", "format": "date-time" }, "erinnerungsDatum": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FristArt": { "type": "object", "properties": { "text": { "maxLength": 254, "type": "string", "nullable": true }, "tage": { "type": "integer", "format": "int32", "nullable": true }, "monate": { "type": "integer", "format": "int32", "nullable": true }, "jahre": { "type": "integer", "format": "int32", "nullable": true }, "bemerkung": { "maxLength": 50, "type": "string", "nullable": true }, "vorFrist": { "type": "integer", "format": "int32", "nullable": true }, "notFrist": { "maxLength": 1, "type": "string", "nullable": true }, "dauer": { "type": "string", "format": "date-time", "nullable": true }, "vorFrist2": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FristN": { "type": "object", "properties": { "datumBeginn": { "type": "string", "format": "date-time", "nullable": true }, "art": { "type": "string", "nullable": true }, "nr": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string", "nullable": true }, "frNr": { "type": "integer", "format": "int32", "nullable": true }, "erledigt": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "anwaltLang": { "type": "string", "nullable": true }, "kuerzel": { "type": "string", "nullable": true }, "sb": { "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "vorfrist": { "type": "string", "format": "date-time", "nullable": true }, "notfrist": { "type": "string", "nullable": true }, "adressat": { "type": "integer", "format": "int32", "nullable": true }, "master": { "type": "integer", "format": "int32", "nullable": true }, "erledigt_Datum": { "type": "string", "format": "date-time", "nullable": true }, "privat": { "type": "string", "nullable": true }, "artNr": { "type": "integer", "format": "int32", "nullable": true }, "kz": { "type": "integer", "format": "int32", "nullable": true }, "prioritaet": { "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "dauer": { "type": "string", "format": "date-span", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "hNr": { "type": "integer", "format": "int32", "nullable": true }, "gespraechspartner": { "type": "string", "nullable": true }, "rufnummer": { "type": "string", "nullable": true }, "zuletztGeaendertAm": { "type": "string", "format": "date-time", "nullable": true }, "erinnerungsDatum": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FristenNr": { "type": "object", "properties": { "frnr": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "HistoryEntry": { "type": "object", "properties": { "rowId": { "type": "string", "nullable": true }, "hNr": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" }, "akte": { "type": "integer", "format": "int32" }, "az": { "type": "string", "nullable": true }, "rubrum": { "type": "string", "nullable": true }, "dat": { "type": "string", "format": "date-time", "nullable": true }, "art": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "datei": { "type": "string", "nullable": true }, "vorgelegt": { "type": "string", "nullable": true }, "benutzer": { "type": "string", "nullable": true }, "gelesen": { "type": "string", "format": "date-time", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "HistoryEntryAdd": { "type": "object", "properties": { "rowId": { "type": "string", "nullable": true }, "hNr": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" }, "akte": { "type": "integer", "format": "int32" }, "az": { "type": "string", "nullable": true }, "rubrum": { "type": "string", "nullable": true }, "dat": { "type": "string", "format": "date-time", "nullable": true }, "art": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "datei": { "type": "string", "nullable": true }, "vorgelegt": { "type": "string", "nullable": true }, "benutzer": { "type": "string", "nullable": true }, "gelesen": { "type": "string", "format": "date-time", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "posteingang": { "$ref": "#/components/schemas/ePosteingang" }, "visibleOnline": { "type": "boolean" }, "versendeart": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoryParameter": { "type": "object", "properties": { "betNr": { "type": "integer", "format": "int32" }, "dat": { "type": "string", "format": "date-time", "nullable": true }, "art": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "datei": { "type": "string", "nullable": true }, "benutzer": { "type": "string", "nullable": true }, "gelesen": { "type": "string", "format": "date-time", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "methodigy": { "type": "boolean" }, "vorgelegt": { "type": "string", "nullable": true }, "posteingang": { "$ref": "#/components/schemas/ePosteingang" }, "visibleOnline": { "type": "boolean" }, "versendeart": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HistoryQueryParam": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "\n\n0 = ALLES\n\n1 = NUR_DATEIEN\n\n2 = KEINE_DATEIEN", "format": "int32", "x-enumNames": [ "ALLES", "NUR_DATEIEN", "KEINE_DATEIEN" ], "x-enumDescriptions": [ "", "", "" ] }, "HistoryTreeParams": { "type": "object", "properties": { "ordnerNr": { "type": "integer", "format": "int32" }, "akte": { "type": "integer", "format": "int32" }, "hnr": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "INewMessageResult": { "type": "object", "properties": { "messageId": { "type": "integer", "format": "int64", "readOnly": true }, "chatId": { "type": "integer", "format": "int32", "readOnly": true }, "rubrum": { "type": "string", "nullable": true, "readOnly": true }, "akte": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "sentTo": { "type": "array", "items": { "$ref": "#/components/schemas/MitarbeiterBase" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IdParam": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "IdentityLoggedIn": { "type": "object", "properties": { "kanzlei": { "type": "string", "nullable": true }, "database": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/eRole" }, "userID": { "type": "integer", "format": "int32" }, "userShort": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InboxEntry": { "type": "object", "properties": { "rowId": { "type": "string", "nullable": true }, "hNr": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" }, "akte": { "type": "integer", "format": "int32" }, "az": { "type": "string", "nullable": true }, "rubrum": { "type": "string", "nullable": true }, "dat": { "type": "string", "format": "date-time", "nullable": true }, "art": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "datei": { "type": "string", "nullable": true }, "vorgelegt": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Info": { "type": "object", "properties": { "path": { "type": "string", "nullable": true }, "length": { "type": "integer", "format": "int32" }, "creationTimeUtc": { "type": "string", "format": "date-time" }, "lastWriteTimeUtc": { "type": "string", "format": "date-time" }, "attributes": { "$ref": "#/components/schemas/FileAttributes" } }, "additionalProperties": false }, "InvoiceResult": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "invoiceId": { "type": "integer", "format": "int32" }, "paymentUrl": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "format": "uuid" }, "sku": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "vatRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "InvoiceResultResult": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" }, "payload": { "$ref": "#/components/schemas/InvoiceResult" }, "paginationInfo": { "$ref": "#/components/schemas/Pagination" } }, "additionalProperties": false }, "KommKz": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "description": "\n\n1 = TelGesch\n\n2 = FaxGesch\n\n3 = Mobil\n\n4 = MailGesch\n\n5 = Internet\n\n6 = TelPrivat\n\n7 = FaxPrivat\n\n8 = MailPrivat\n\n9 = AutoTelefon\n\n10 = Sonstige\n\n11 = EPost\n\n12 = Bea", "format": "int32", "x-enumNames": [ "TelGesch", "FaxGesch", "Mobil", "MailGesch", "Internet", "TelPrivat", "FaxPrivat", "MailPrivat", "AutoTelefon", "Sonstige", "EPost", "Bea" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Kommunikation": { "type": "object", "properties": { "tlf": { "type": "string", "nullable": true }, "bemerkung": { "type": "string", "nullable": true }, "kommKz": { "$ref": "#/components/schemas/KommKz" }, "online": { "type": "boolean" }, "rowId": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" }, "kommArt": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "KommunikationParameter": { "type": "object", "properties": { "tlf": { "type": "string", "nullable": true }, "bemerkung": { "type": "string", "nullable": true }, "kommKz": { "$ref": "#/components/schemas/KommKz" }, "online": { "type": "boolean" } }, "additionalProperties": false }, "Kontaktperson": { "type": "object", "properties": { "abteilung": { "maxLength": 50, "type": "string", "nullable": true }, "position": { "maxLength": 50, "type": "string", "nullable": true }, "bezeichnung": { "maxLength": 50, "type": "string", "nullable": true }, "bemerkung": { "maxLength": 250, "type": "string", "nullable": true }, "mitNr": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "strasse": { "type": "string", "nullable": true }, "plz": { "type": "string", "nullable": true }, "ort": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "betNr": { "type": "integer", "format": "int32" }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KontaktpersonParameter": { "type": "object", "properties": { "abteilung": { "maxLength": 50, "type": "string", "nullable": true }, "position": { "maxLength": 50, "type": "string", "nullable": true }, "bezeichnung": { "maxLength": 50, "type": "string", "nullable": true }, "bemerkung": { "maxLength": 250, "type": "string", "nullable": true }, "mitNr": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "strasse": { "type": "string", "nullable": true }, "plz": { "type": "string", "nullable": true }, "ort": { "type": "string", "nullable": true } }, "additionalProperties": false }, "KontaktpersonParameterMitBetNr": { "type": "object", "properties": { "abteilung": { "maxLength": 50, "type": "string", "nullable": true }, "position": { "maxLength": 50, "type": "string", "nullable": true }, "bezeichnung": { "maxLength": 50, "type": "string", "nullable": true }, "bemerkung": { "maxLength": 250, "type": "string", "nullable": true }, "mitNr": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "strasse": { "type": "string", "nullable": true }, "plz": { "type": "string", "nullable": true }, "ort": { "type": "string", "nullable": true }, "betnr": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MessageStatus": { "type": "object", "properties": { "messageId": { "type": "integer", "format": "int64", "nullable": true }, "chatId": { "type": "integer", "format": "int32", "nullable": true }, "gelesen": { "type": "string", "format": "date-time", "nullable": true }, "empfangen": { "type": "string", "format": "date-time", "nullable": true }, "geloescht": { "type": "boolean", "nullable": true }, "flags": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Mitarbeiter": { "type": "object", "properties": { "kuerzel": { "type": "string", "nullable": true }, "maNr": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "sb": { "type": "boolean" }, "passiv": { "type": "boolean" }, "nachrichten": { "type": "boolean" } }, "additionalProperties": false }, "MitarbeiterBase": { "type": "object", "properties": { "kuerzel": { "type": "string", "nullable": true }, "maNr": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Nachricht": { "type": "object", "properties": { "uId": { "type": "integer", "format": "int32" }, "zeitpunkt": { "type": "string", "format": "date-time" }, "text": { "type": "string", "nullable": true }, "von": { "type": "integer", "format": "int32" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/Status" }, "nullable": true } }, "additionalProperties": false }, "NewActivity": { "type": "object", "properties": { "naNr": { "type": "integer", "format": "int32" }, "tableName": { "maxLength": 50, "type": "string", "nullable": true }, "tableIndex": { "type": "integer", "format": "int32" }, "fetched": { "type": "string", "format": "date-time", "nullable": true }, "parentRowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewActivityFetchedParams": { "type": "object", "properties": { "newActivityNrs": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "NewChat": { "type": "object", "properties": { "titel": { "type": "string", "nullable": true }, "akte": { "type": "integer", "format": "int32", "nullable": true }, "teilnehmer": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "Ordner": { "type": "object", "properties": { "ordnerNr": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "parent": { "type": "integer", "format": "int32" }, "previous": { "type": "integer", "format": "int32" }, "hNr": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "Pagination": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "itemsPerPage": { "type": "integer", "format": "int32" }, "lastPageNumber": { "type": "integer", "format": "int32" }, "totalsCount": { "type": "integer", "format": "int32" }, "isLastPage": { "type": "boolean", "readOnly": true }, "firstOnPage": { "type": "integer", "format": "int32" }, "lastOnPage": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Rechnung": { "type": "object", "properties": { "akteNr": { "type": "integer", "format": "int32" }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "faellig": { "type": "string", "format": "date-time", "nullable": true }, "betrag": { "type": "number", "format": "double" }, "ustSatz": { "type": "number", "format": "double", "nullable": true }, "ust": { "type": "number", "format": "double", "nullable": true }, "betNr": { "type": "integer", "format": "int32" }, "leistungszeitraum": { "maxLength": 50, "type": "string", "nullable": true }, "empfaenger": { "maxLength": 200, "type": "string", "nullable": true }, "bez": { "maxLength": 75, "type": "string", "nullable": true }, "referat": { "maxLength": 50, "type": "string", "nullable": true }, "benutzer": { "maxLength": 50, "type": "string", "nullable": true }, "datei": { "maxLength": 254, "type": "string", "nullable": true }, "buchungErzeugen": { "type": "boolean", "nullable": true }, "buchungText": { "type": "string", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RechnungParameter": { "type": "object", "properties": { "akteNr": { "type": "integer", "format": "int32" }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "faellig": { "type": "string", "format": "date-time", "nullable": true }, "betrag": { "type": "number", "format": "double" }, "ustSatz": { "type": "number", "format": "double", "nullable": true }, "ust": { "type": "number", "format": "double", "nullable": true }, "betNr": { "type": "integer", "format": "int32" }, "leistungszeitraum": { "maxLength": 50, "type": "string", "nullable": true }, "empfaenger": { "maxLength": 200, "type": "string", "nullable": true }, "bez": { "maxLength": 75, "type": "string", "nullable": true }, "referat": { "maxLength": 50, "type": "string", "nullable": true }, "benutzer": { "maxLength": 50, "type": "string", "nullable": true }, "datei": { "maxLength": 254, "type": "string", "nullable": true }, "buchungErzeugen": { "type": "boolean", "nullable": true }, "buchungText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Rechtsform": { "type": "object", "properties": { "text": { "maxLength": 50, "type": "string", "nullable": true }, "nperson": { "maxLength": 1, "type": "string", "nullable": true } }, "additionalProperties": false }, "ReferatBase": { "type": "object", "properties": { "kuerzel": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "referatSpezifischeDaten": { "type": "string", "nullable": true }, "tabelle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Status": { "type": "object", "properties": { "maNr": { "type": "integer", "format": "int32" }, "gelesen": { "type": "string", "format": "date-time", "nullable": true }, "empfangen": { "type": "string", "format": "date-time", "nullable": true }, "geloescht": { "type": "boolean" }, "flags": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Stellung": { "type": "object", "properties": { "bezeichnung": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "StringStringValuesKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Termin": { "type": "object", "properties": { "frNr": { "type": "integer", "format": "int32" }, "nr": { "type": "integer", "format": "int32" }, "datum": { "type": "string", "format": "date-time" }, "uhrzeitBis": { "type": "string", "format": "date-span" }, "uhrzeitBisTicks": { "type": "integer", "format": "int64" }, "datumBis": { "type": "string", "format": "date-time" }, "text": { "maxLength": 254, "type": "string", "nullable": true }, "notiz": { "maxLength": 254, "type": "string", "nullable": true }, "ort": { "maxLength": 100, "type": "string", "nullable": true }, "raum": { "maxLength": 20, "type": "string", "nullable": true }, "erinnerung": { "type": "integer", "format": "int32" }, "erinnerungsDauer": { "type": "string", "format": "date-span" }, "erinnerungsDauerTicks": { "type": "integer", "format": "int64" }, "vorbereitungsDauer": { "type": "string", "format": "date-span" }, "fahrzeit": { "type": "string", "format": "date-span" }, "plz": { "maxLength": 20, "type": "string", "nullable": true }, "strasse": { "maxLength": 50, "type": "string", "nullable": true }, "erinnerungsDatum": { "type": "string", "format": "date-time" }, "dauertermin": { "type": "integer", "format": "int32" }, "abwesenheit": { "type": "integer", "format": "int32" }, "sb": { "maxLength": 5, "type": "string", "nullable": true }, "sachbearbeiter": { "type": "string", "nullable": true }, "anwaltLang": { "type": "string", "nullable": true }, "anwalt": { "maxLength": 5, "type": "string", "nullable": true }, "vortermin": { "type": "integer", "format": "int32" }, "erneutErinnern": { "type": "integer", "format": "int32" }, "zuletztGeaendertAm": { "type": "string", "format": "date-time" }, "zuletztGeaendertVon": { "maxLength": 5, "type": "string", "nullable": true }, "optionalAttendees": { "type": "string", "nullable": true }, "turnus": { "type": "integer", "format": "int32" }, "turnusArt": { "type": "integer", "format": "int32" }, "erledigt": { "type": "integer", "format": "int32" }, "erledigtAm": { "type": "string", "format": "date-time", "nullable": true }, "geloescht": { "type": "integer", "format": "int32" }, "ortFahrzeit": { "maxLength": 100, "type": "string", "nullable": true }, "fahrtAnzeigen": { "type": "integer", "format": "int32" }, "privat": { "type": "integer", "format": "int32" }, "urlaubsArt": { "type": "integer", "format": "int32" }, "urlaubsTage": { "type": "number", "format": "double" }, "rowId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UmsatzRefMitarbeiter": { "type": "object", "properties": { "mitarbeiterKuerzel": { "type": "string", "nullable": true }, "referat": { "type": "string", "nullable": true }, "jahr": { "type": "integer", "format": "int32" }, "umsatz": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Unfall": { "type": "object", "properties": { "amtlKennzeichenMdt": { "maxLength": 20, "type": "string", "nullable": true }, "kfzTypMdt": { "maxLength": 20, "type": "string", "nullable": true }, "halterMdt": { "maxLength": 100, "type": "string", "nullable": true }, "fahrerMdt": { "maxLength": 100, "type": "string", "nullable": true }, "werkstattMdt": { "maxLength": 150, "type": "string", "nullable": true }, "fahrerIstHalterMdt": { "type": "boolean", "nullable": true }, "erstzulassungMdt": { "type": "string", "format": "date-time", "nullable": true }, "kmStandMdt": { "type": "integer", "format": "int32", "nullable": true }, "gestellNrMdt": { "maxLength": 30, "type": "string", "nullable": true }, "halterBetNrMdt": { "type": "integer", "format": "int32", "nullable": true }, "fahrerBetNrMdt": { "type": "integer", "format": "int32", "nullable": true }, "versBetNrMdt": { "type": "integer", "format": "int32", "nullable": true }, "fahrzeugArtMdt": { "maxLength": 20, "type": "string", "nullable": true }, "anzahlVorbesitzer": { "type": "integer", "format": "int32", "nullable": true }, "hsnMdt": { "maxLength": 4, "type": "string", "nullable": true }, "tsnMdt": { "maxLength": 3, "type": "string", "nullable": true }, "modellMdt": { "maxLength": 30, "type": "string", "nullable": true }, "versicherungMdt": { "maxLength": 100, "type": "string", "nullable": true }, "vollkasko": { "type": "boolean" }, "vollkaskoSelbstbeteiligung": { "type": "number", "format": "double", "nullable": true }, "teilkasko": { "type": "boolean" }, "teilkaskoSelbstbeteiligung": { "type": "number", "format": "double", "nullable": true }, "amtlKennzeichenGeg": { "maxLength": 20, "type": "string", "nullable": true }, "kfzTypGeg": { "maxLength": 20, "type": "string", "nullable": true }, "halterGeg": { "maxLength": 100, "type": "string", "nullable": true }, "fahrerGeg": { "maxLength": 100, "type": "string", "nullable": true }, "werkstattGeg": { "maxLength": 150, "type": "string", "nullable": true }, "fahrerIstHalterGeg": { "type": "boolean", "nullable": true }, "halterBetNrGeg": { "type": "integer", "format": "int32", "nullable": true }, "fahrerBetNrGeg": { "type": "integer", "format": "int32", "nullable": true }, "versBetNrGeg": { "type": "integer", "format": "int32", "nullable": true }, "fahrzeugArtGeg": { "maxLength": 20, "type": "string", "nullable": true }, "hsnGeg": { "maxLength": 4, "type": "string", "nullable": true }, "tsnGeg": { "maxLength": 3, "type": "string", "nullable": true }, "modellGeg": { "maxLength": 30, "type": "string", "nullable": true }, "versicherungGeg": { "maxLength": 100, "type": "string", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "zeit": { "type": "string", "format": "date-time", "nullable": true }, "strasse": { "maxLength": 100, "type": "string", "nullable": true }, "plz": { "maxLength": 5, "type": "string", "nullable": true }, "ort": { "maxLength": 100, "type": "string", "nullable": true }, "land": { "maxLength": 3, "type": "string", "nullable": true }, "zeugenanschrift": { "maxLength": 254, "type": "string", "nullable": true }, "zeugen": { "type": "boolean", "nullable": true }, "sachverstaendigen": { "maxLength": 254, "type": "string", "nullable": true }, "sachverstaendigenBetNr": { "type": "integer", "format": "int32", "nullable": true }, "polizei": { "maxLength": 254, "type": "string", "nullable": true }, "polizeiBetNr": { "type": "integer", "format": "int32", "nullable": true }, "tageBuchNr": { "maxLength": 30, "type": "string", "nullable": true }, "hergangSchl": { "type": "boolean", "nullable": true }, "reparaturkosten": { "type": "number", "format": "double", "nullable": true }, "wertminderung": { "type": "number", "format": "double", "nullable": true }, "wiederbeschaffung": { "type": "number", "format": "double", "nullable": true }, "restwert": { "type": "number", "format": "double", "nullable": true }, "zulassungMdt": { "maxLength": 100, "type": "string", "nullable": true }, "zulassungGeg": { "maxLength": 100, "type": "string", "nullable": true }, "leih": { "type": "boolean", "nullable": true }, "abrGut": { "type": "boolean", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "akteId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UnfallParameter": { "type": "object", "properties": { "amtlKennzeichenMdt": { "maxLength": 20, "type": "string", "nullable": true }, "kfzTypMdt": { "maxLength": 20, "type": "string", "nullable": true }, "halterMdt": { "maxLength": 100, "type": "string", "nullable": true }, "fahrerMdt": { "maxLength": 100, "type": "string", "nullable": true }, "werkstattMdt": { "maxLength": 150, "type": "string", "nullable": true }, "fahrerIstHalterMdt": { "type": "boolean", "nullable": true }, "erstzulassungMdt": { "type": "string", "format": "date-time", "nullable": true }, "kmStandMdt": { "type": "integer", "format": "int32", "nullable": true }, "gestellNrMdt": { "maxLength": 30, "type": "string", "nullable": true }, "halterBetNrMdt": { "type": "integer", "format": "int32", "nullable": true }, "fahrerBetNrMdt": { "type": "integer", "format": "int32", "nullable": true }, "versBetNrMdt": { "type": "integer", "format": "int32", "nullable": true }, "fahrzeugArtMdt": { "maxLength": 20, "type": "string", "nullable": true }, "anzahlVorbesitzer": { "type": "integer", "format": "int32", "nullable": true }, "hsnMdt": { "maxLength": 4, "type": "string", "nullable": true }, "tsnMdt": { "maxLength": 3, "type": "string", "nullable": true }, "modellMdt": { "maxLength": 30, "type": "string", "nullable": true }, "versicherungMdt": { "maxLength": 100, "type": "string", "nullable": true }, "vollkasko": { "type": "boolean" }, "vollkaskoSelbstbeteiligung": { "type": "number", "format": "double", "nullable": true }, "teilkasko": { "type": "boolean" }, "teilkaskoSelbstbeteiligung": { "type": "number", "format": "double", "nullable": true }, "amtlKennzeichenGeg": { "maxLength": 20, "type": "string", "nullable": true }, "kfzTypGeg": { "maxLength": 20, "type": "string", "nullable": true }, "halterGeg": { "maxLength": 100, "type": "string", "nullable": true }, "fahrerGeg": { "maxLength": 100, "type": "string", "nullable": true }, "werkstattGeg": { "maxLength": 150, "type": "string", "nullable": true }, "fahrerIstHalterGeg": { "type": "boolean", "nullable": true }, "halterBetNrGeg": { "type": "integer", "format": "int32", "nullable": true }, "fahrerBetNrGeg": { "type": "integer", "format": "int32", "nullable": true }, "versBetNrGeg": { "type": "integer", "format": "int32", "nullable": true }, "fahrzeugArtGeg": { "maxLength": 20, "type": "string", "nullable": true }, "hsnGeg": { "maxLength": 4, "type": "string", "nullable": true }, "tsnGeg": { "maxLength": 3, "type": "string", "nullable": true }, "modellGeg": { "maxLength": 30, "type": "string", "nullable": true }, "versicherungGeg": { "maxLength": 100, "type": "string", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "zeit": { "type": "string", "format": "date-time", "nullable": true }, "strasse": { "maxLength": 100, "type": "string", "nullable": true }, "plz": { "maxLength": 5, "type": "string", "nullable": true }, "ort": { "maxLength": 100, "type": "string", "nullable": true }, "land": { "maxLength": 3, "type": "string", "nullable": true }, "zeugenanschrift": { "maxLength": 254, "type": "string", "nullable": true }, "zeugen": { "type": "boolean", "nullable": true }, "sachverstaendigen": { "maxLength": 254, "type": "string", "nullable": true }, "sachverstaendigenBetNr": { "type": "integer", "format": "int32", "nullable": true }, "polizei": { "maxLength": 254, "type": "string", "nullable": true }, "polizeiBetNr": { "type": "integer", "format": "int32", "nullable": true }, "tageBuchNr": { "maxLength": 30, "type": "string", "nullable": true }, "hergangSchl": { "type": "boolean", "nullable": true }, "reparaturkosten": { "type": "number", "format": "double", "nullable": true }, "wertminderung": { "type": "number", "format": "double", "nullable": true }, "wiederbeschaffung": { "type": "number", "format": "double", "nullable": true }, "restwert": { "type": "number", "format": "double", "nullable": true }, "zulassungMdt": { "maxLength": 100, "type": "string", "nullable": true }, "zulassungGeg": { "maxLength": 100, "type": "string", "nullable": true }, "leih": { "type": "boolean", "nullable": true }, "abrGut": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Versendungsart": { "type": "object", "properties": { "vnr": { "type": "integer", "format": "int32" }, "art": { "maxLength": 50, "type": "string", "nullable": true }, "porto": { "type": "boolean", "nullable": true }, "ausgangspost": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Vorgang": { "type": "object", "properties": { "text": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "VorgelegtParams": { "type": "object", "properties": { "kz": { "$ref": "#/components/schemas/eVorgelegtKz" }, "hnr": { "type": "integer", "format": "int32" }, "mitarbeiterNr": { "type": "integer", "format": "int32", "deprecated": true }, "vorgelegtVon": { "type": "integer", "format": "int32", "nullable": true }, "vorlegenAn": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "versendeart": { "type": "string", "nullable": true }, "postausgangsStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Vstab": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "\n\n0 = NichtBerechtigt\n\n1 = Berechtigt\n\n2 = Befreit\n\n3 = EigeneSache\n\n4 = InnergLeistungen", "format": "int32", "x-enumNames": [ "NichtBerechtigt", "Berechtigt", "Befreit", "EigeneSache", "InnergLeistungen" ], "x-enumDescriptions": [ "", "", "", "", "" ] }, "Wegen": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Wiedervorlage": { "type": "object", "properties": { "nr": { "type": "integer", "format": "int32", "nullable": true }, "sb": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "prioritaet": { "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "notizen": { "type": "string", "nullable": true }, "rowId": { "type": "string", "nullable": true }, "frNr": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WiedervorlageParameter": { "type": "object", "properties": { "nr": { "type": "integer", "format": "int32", "nullable": true }, "sb": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "prioritaet": { "type": "string", "nullable": true }, "datum": { "type": "string", "format": "date-time", "nullable": true }, "notizen": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Zeiterfassung": { "type": "object", "properties": { "akteId": { "type": "integer", "format": "int32", "nullable": true }, "erstelltVon": { "type": "string", "nullable": true }, "erfasstVon": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "art": { "type": "string", "nullable": true }, "von": { "type": "string", "format": "date-time" }, "bis": { "type": "string", "format": "date-time" }, "dauer": { "type": "string", "format": "date-span" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ZeiterfassungParameter": { "type": "object", "properties": { "akteId": { "type": "integer", "format": "int32", "nullable": true }, "erstelltVon": { "type": "string", "nullable": true }, "erfasstVon": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "art": { "type": "string", "nullable": true }, "von": { "type": "string", "format": "date-time" }, "bis": { "type": "string", "format": "date-time" }, "dauer": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "ePosteingang": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "\n\n0 = None\n\n1 = SB\n\n2 = All", "format": "int32", "x-enumNames": [ "None", "SB", "All" ], "x-enumDescriptions": [ "", "", "" ] }, "eRole": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 39, 63 ], "type": "integer", "description": "\n\n0 = None\n\n1 = Master\n\n2 = Mitarbeiter\n\n4 = Mandant\n\n8 = Gast\n\n16 = OnPremise\n\n32 = ApiUser\n\n39 = AllLoggedIn\n\n63 = All", "format": "int32", "x-enumNames": [ "None", "Master", "Mitarbeiter", "Mandant", "Gast", "OnPremise", "ApiUser", "AllLoggedIn", "All" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "" ] }, "eVorgelegtKz": { "enum": [ 1, 2 ], "type": "integer", "description": "\n\n1 = Posteingang\n\n2 = Postausgang", "format": "int32", "x-enumNames": [ "Posteingang", "Postausgang" ], "x-enumDescriptions": [ "", "" ] } }, "securitySchemes": { "bearer": { "type": "http", "description": "JWT Authorization header Bearer schema", "scheme": "bearer" } } }, "security": [ { "basic": [ ] } ] }