{ "swagger": "2.0", "info": { "title": "iPM_Promotion", "description": "Die API von iPM_Promotion dient zum Zugriff auf Daten der kundenindividuellen iPM_Promotion-Systeme.\n\n### API Endpunkte\nDie Endpunkte der API liegen auf den kunden- und systemindividuellen URLs unter **https://meine-domain.de/api/1/**, wobei /1 für die Version steht.\nZum Beispiel liegt der Termin-Endpunkt für die Domain promosoftware.de auf https://promosoftware.de/api/1/termine.\n\n### Authentifizierung\nDie Authentifizierung erfolgt über einen API-Key. Dieser **kunden- und systemindividuelle Key** muss als GET-Parameter `api-key` oder über einen HTTP-Header `api-key` übermittelt werden.\n\n### Rückgabeformate\nDas Format der Rückgabe kann in **JSON** oder **XML** erfolgen und wird über die URL spezifiziert (z.B. https://promosoftware.de/api/1/termine.xml).\nWird kein Format spezifiziert, erfolgt die Rückgabe in JSON.\n\nEine Ausnahme hierbei stellt die Kalender-API dar (kalender/*). Hierbei erfolgt die Rückgabe im iCal-Format.\n\n### Limit & Offset\nBei der Abfrage von Daten über die API ist die Rückgabe auf maximal 20.000 Datensätze in einem Request beschränkt. Innerhalb der Requests kann die Rückgabe über die GET-Parameter `limit` und `offset` gesteuert werden. Der limit-Parameter steuert hierbei die Anzahl der Datensätze die zurückgegeben werden, der offset-Parameter steuert ab welchem Element/Datensatz die Werte zurückgegeben werden.\n\n### API-Kategorien/Bereiche\nFolgende Systembereiche können über die API abgefragt werden:\n- Projekte\n- Jobs\n- Termine\n- Einsätze\n- Aktionsstandorte\n- Profile\n- Feedbacks\n- Einsatz-Abrechnungen\n\n **Wichtig:** Bei Projekten, Jobs, Terminen und Einsätzen werden nur nicht-stornierte Datensätze zurückgegeben!\n\n### Datenstrukturen\nWir unterteilen bei der Abfrage von Daten in Grunddaten und erweiterte Daten. In iPM_Promotion wird mit hierarchisch\nangeordneten Daten gearbeitet (Projekt, Job, Termin und Einsatz). Damit eine Zuordnung zu den Bereichen\nmöglich ist, werden z.B. auch bei Terminen und Einsätzen die Grunddaten der Projekte und Jobs mit ausgegeben.\n\nDaher erfolgt in den Datenstrukturen die Differenzierung zwischen den Grunddaten und den normalen/erweiterten Daten\n(siehe die verschiedenen Datenstrukturen in den Models). Werden die Projekte abgefragt, so werden die\nnormalen/erweiterten Daten zurückgegeben. Werden die Termine abgefragt, so beinhaltet ein Termin lediglich die\nGrunddaten des Projekts. Sollen hier auch alle Daten ausgegeben werden, so muss der GET-Parameter `erweiterteDaten`\nmit angegeben werden (z.B.: https://promosoftware.de/api/1/termine.json&api-key=123456&erweiterteDaten=projekt,job,aktionsstandort).\n\nEine gewisse Sonderrolle nehmen hierbei die Datenstrukturen der Feedbacks ein. Diese beinhalten eine Collection der Fragen-Auswertungen,\nalso aller möglichen Einzelinformationen die für Auswertungen zur Verfügung stehen (z.B. alle Summierungen und Zählungen die vom System\nautomatisch errechnet werden). Diese Collection bildet sich dynamisch auf Basis der im Fragebogen hinterlegten Elemente.\n **Achtung:** Die API befindet sich noch im Beta-Stadium, d.h. es kann zu Änderungen kommen. Hierbei versuchen wir,\ndie Änderungen dahingehend zu beschränken, dass z.B. nicht einfach API-Endpunkte entfernt,\nkomplett geändert oder nach außen kommunizierte Informationen/Eigenschaften entfernt werden.\nJedoch ist es z.B. möglich, dass neue Abfrage-Parameter für die Filterung von Daten oder\nneue Eigenschaften in den Abfragen ergänzt werden.", "version": "1.0.0" }, "host": "ihre-domain.de", "basePath": "/api/1", "paths": { "/aktionsstandorte/{aktionsstandort_id}": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage eines einzelnen Aktionsstandorts.", "description": "Rückgabe des abgefragten Aktionsstandorts.", "parameters": [ { "$ref": "#/parameters/aktionsstandorte.id" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/aktionsstandorte": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage von Aktionsstandorten.", "description": "Rückgabe der abgefragten Aktionsstandorte", "parameters": [ { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/projekte/{projekt_id}/aktionsstandorte": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage von Aktionsstandorten zu einem Projekt.", "description": "Rückgabe der abgefragten Aktionsstandorte eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/jobs/{job_id}/aktionsstandorte": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage von Aktionsstandorten zu einem Job.", "description": "Rückgabe der abgefragten Aktionsstandorte eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/aktionsstandorte": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage von Aktionsstandorten zu einem Kunden.", "description": "Rückgabe der abgefragten Aktionsstandorte eines Kunden. Hierbei werden die Aktionsstandorte aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/projekte/{projekt_id}/aktionsstandorte": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage von Aktionsstandorten zu einem Projekt eines Kunden.", "description": "Rückgabe der abgefragten Aktionsstandorte zu einem Projekt eines Kunden. Hierbei werden die Aktionsstandorte aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/jobs/{job_id}/aktionsstandorte": { "get": { "tags": [ "aktionsstandorte" ], "summary": "Abfrage von Aktionsstandorten zu einem Job eines Kunden.", "description": "Rückgabe der abgefragten Aktionsstandorte zu einem Job eines Kunden. Hierbei werden die Aktionsstandorte aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/aktionsstandorte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/einsaetze/{einsatz_id}": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage eines einzelnen Einsatzes.", "description": "Rückgabe des abgefragten Einsatzes.", "parameters": [ { "$ref": "#/parameters/einsaetze.id" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen.", "description": "Rückgabe der abgefragten Einsätze", "parameters": [ { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/profile/{profil_id}/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen zu einem Profil.", "description": "Rückgabe der abgefragten Einsätze eines Profils.", "parameters": [ { "$ref": "#/parameters/profile.id" }, { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/projekte/{projekt_id}/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen zu einem Projekt.", "description": "Rückgabe der abgefragten Einsätze eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/jobs/{job_id}/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen zu einem Job.", "description": "Rückgabe der abgefragten Einsätze eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen zu einem Kunden.", "description": "Rückgabe der abgefragten Einsätze eines Kunden. Hierbei werden die Einsätze aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/projekte/{projekt_id}/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen zu einem Projekt eines Kunden.", "description": "Rückgabe der abgefragten Einsätze zu einem Projekt eines Kunden. Hierbei werden die Einsätze aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/jobs/{job_id}/einsaetze": { "get": { "tags": [ "einsaetze" ], "summary": "Abfrage von Einsätzen zu einem Job eines Kunden.", "description": "Rückgabe der abgefragten Einsätze zu einem Job eines Kunden. Hierbei werden die Einsätze aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/einsaetze.einsatzstatus" }, { "$ref": "#/parameters/einsaetze.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsaetze.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/einsatzabrechnungen/{einsatzabrechnung_id}": { "get": { "tags": [ "einsatzabrechnungen" ], "summary": "Abfrage einer einzelnen Einsatz-Abrechnung.", "description": "Rückgabe der abgefragten Einsatz-Abrechnung.", "parameters": [ { "$ref": "#/parameters/einsatzabrechnungen.id" } ], "responses": { "200": { "$ref": "#/responses/einsatzabrechnungen.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/einsatzabrechnungen": { "get": { "tags": [ "einsatzabrechnungen" ], "summary": "Abfrage von Einsatz-Abrechnungen.", "description": "Rückgabe der abgefragten Einsatz-Abrechnungen.", "parameters": [ { "$ref": "#/parameters/einsatzabrechnungen.abrechnungsstatus" }, { "$ref": "#/parameters/einsatzabrechnungen.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsatzabrechnungen.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/projekte/{projekt_id}/einsatzabrechnungen": { "get": { "tags": [ "einsatzabrechnungen" ], "summary": "Abfrage von Einsatz-Abrechnungen zu einem Projekt.", "description": "Rückgabe der abgefragten Einsatz-Abrechnungen eines Projekt.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/einsatzabrechnungen.abrechnungsstatus" }, { "$ref": "#/parameters/einsatzabrechnungen.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsatzabrechnungen.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/jobs/{job_id}/einsatzabrechnungen": { "get": { "tags": [ "einsatzabrechnungen" ], "summary": "Abfrage von Einsatz-Abrechnungen zu einem Job.", "description": "Rückgabe der abgefragten Einsatz-Abrechnungen eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/einsatzabrechnungen.abrechnungsstatus" }, { "$ref": "#/parameters/einsatzabrechnungen.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsatzabrechnungen.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/profile/{profil_id}/einsatzabrechnungen": { "get": { "tags": [ "einsatzabrechnungen" ], "summary": "Abfrage von Einsatz-Abrechnungen zu einem Profil.", "description": "Rückgabe der abgefragten Einsatz-Abrechnungen eines Profils.", "parameters": [ { "$ref": "#/parameters/profile.id" }, { "$ref": "#/parameters/einsatzabrechnungen.abrechnungsstatus" }, { "$ref": "#/parameters/einsatzabrechnungen.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/einsatzabrechnungen.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/feedbacks/{feedback_id}": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage eines einzelnen Feedbacks.", "description": "Rückgabe des abgefragten Feedbacks.", "parameters": [ { "$ref": "#/parameters/feedbacks.id" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/frageboegen/{fragebogen_id}/feedbacks": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage von Feedbacks zu einem Fragebogen.", "description": "Rückgabe der abgefragten Feedbacks eines Fragebogens.", "parameters": [ { "$ref": "#/parameters/frageboegen.id" }, { "$ref": "#/parameters/feedbacks.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/projekte/{projekt_id}/frageboegen/{fragebogen_id}/feedbacks": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage von Feedbacks zu einem Projekt und einem Fragebogen.", "description": "Rückgabe der abgefragten Feedbacks eines Fragebogens innerhalb eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/frageboegen.id" }, { "$ref": "#/parameters/feedbacks.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/jobs/{job_id}/frageboegen/{fragebogen_id}/feedbacks": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage von Feedbacks zu einem Job und einem Fragebogen.", "description": "Rückgabe der abgefragten Feedbacks eines Fragebogens innerhalb eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/frageboegen.id" }, { "$ref": "#/parameters/feedbacks.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/kunden/{kunden_id}/frageboegen/{fragebogen_id}/feedbacks": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage von Feedbacks zu einem Kunden und einem Fragebogen.", "description": "Rückgabe der abgefragten Feedbacks eines Fragebogens für einen Kunden. Hierbei werden die Feedbacks aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/frageboegen.id" }, { "$ref": "#/parameters/feedbacks.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/kunden/{kunden_id}/projekte/{projekt_id}/frageboegen/{fragebogen_id}/feedbacks": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage von Feedbacks zu einem Kunden, einem Projekt und einem Fragebogen.", "description": "Rückgabe der abgefragten Feedbacks eines Fragebogens für einen Kunden innerhalb eines Projekts. Hierbei werden die Feedbacks aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/frageboegen.id" }, { "$ref": "#/parameters/feedbacks.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/kunden/{kunden_id}/jobs/{job_id}/frageboegen/{fragebogen_id}/feedbacks": { "get": { "tags": [ "feedbacks" ], "summary": "Abfrage von Feedbacks zu einem Kunden, einem Job und einem Fragebogen.", "description": "Rückgabe der abgefragten Feedbacks eines Fragebogens für einen Kunden innerhalb eines Jobs. Hierbei werden die Feedbacks aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/frageboegen.id" }, { "$ref": "#/parameters/feedbacks.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/feedbacks.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/jobprofile/{jobprofil_id}": { "get": { "tags": [ "jobProfile" ], "summary": "Abfrage eines einzelnen Job-Profils.", "description": "Rückgabe des abgefragten Job-Profils.", "parameters": [ { "$ref": "#/parameters/jobProfile.id" } ], "responses": { "200": { "$ref": "#/responses/jobProfile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/jobprofile": { "get": { "tags": [ "jobProfile" ], "summary": "Abfrage von Job-Profilen.", "description": "Rückgabe der abgefragten Job-Profile", "parameters": [ { "$ref": "#/parameters/jobProfile.jobprofilstatus" } ], "responses": { "200": { "$ref": "#/responses/jobProfile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/profile/{profil_id}/jobprofile": { "get": { "tags": [ "jobProfile" ], "summary": "Abfrage von Job-Profilen zu einem Profil.", "description": "Rückgabe der abgefragten Job-Profile eines Profils.", "parameters": [ { "$ref": "#/parameters/profile.id" }, { "$ref": "#/parameters/jobProfile.jobprofilstatus" } ], "responses": { "200": { "$ref": "#/responses/jobProfile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/projekte/{projekt_id}/jobprofile": { "get": { "tags": [ "jobProfile" ], "summary": "Abfrage von Job-Profilen zu einem Projekt.", "description": "Rückgabe der abgefragten Job-Profile eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/jobProfile.jobprofilstatus" } ], "responses": { "200": { "$ref": "#/responses/jobProfile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/jobs/{job_id}/jobprofile": { "get": { "tags": [ "jobProfile" ], "summary": "Abfrage von Job-Profilen zu einem Job.", "description": "Rückgabe der abgefragten Job-Profile eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/jobProfile.jobprofilstatus" } ], "responses": { "200": { "$ref": "#/responses/jobProfile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/jobs/{job_id}": { "get": { "tags": [ "jobs" ], "summary": "Abfrage eines einzelnen Jobs.", "description": "Rückgabe des abgefragten Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" } ], "responses": { "200": { "$ref": "#/responses/jobs.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/jobs": { "get": { "tags": [ "jobs" ], "summary": "Abfrage von Jobs.", "description": "Rückgabe der abgefragten Jobs", "parameters": [ { "$ref": "#/parameters/jobs.jobstatus" }, { "$ref": "#/parameters/jobs.taetigkeit" }, { "$ref": "#/parameters/jobs.mit_zuordnungslink" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/jobs.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/projekte/{projekt_id}/jobs": { "get": { "tags": [ "jobs" ], "summary": "Abfrage von Jobs zu einem Projekt.", "description": "Rückgabe der abgefragten Jobs eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/jobs.jobstatus" }, { "$ref": "#/parameters/jobs.taetigkeit" }, { "$ref": "#/parameters/jobs.mit_zuordnungslink" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/jobs.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/jobs": { "get": { "tags": [ "jobs" ], "summary": "Abfrage von Jobs zu einem Kunden.", "description": "Rückgabe der abgefragten Jobs eines Kunden. Hierbei werden die Jobs aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/jobs.jobstatus" }, { "$ref": "#/parameters/jobs.taetigkeit" }, { "$ref": "#/parameters/jobs.mit_zuordnungslink" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/jobs.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/projekte/{projekt_id}/jobs": { "get": { "tags": [ "jobs" ], "summary": "Abfrage von Jobs zu einem Projekt eines Kunden.", "description": "Rückgabe der abgefragten Jobs zu einem Projekt eines Kunden. Hierbei werden die Jobs aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/jobs.jobstatus" }, { "$ref": "#/parameters/jobs.taetigkeit" }, { "$ref": "#/parameters/jobs.mit_zuordnungslink" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/jobs.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/profile/{profil_id}": { "get": { "tags": [ "profile" ], "summary": "Abfrage eines einzelnen Profils.", "description": "Rückgabe des abgefragten Profils.", "parameters": [ { "$ref": "#/parameters/profile.id" } ], "responses": { "200": { "$ref": "#/responses/profile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/profile": { "get": { "tags": [ "profile" ], "summary": "Abfrage von Profilen.", "description": "Rückgabe der abgefragten Profile", "parameters": [ { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/profile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/projekte/{projekt_id}/profile": { "get": { "tags": [ "profile" ], "summary": "Abfrage von Profilen zu einem Projekt.", "description": "Rückgabe der abgefragten Profile eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/profile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/jobs/{job_id}/profile": { "get": { "tags": [ "profile" ], "summary": "Abfrage von Profilen zu einem Job.", "description": "Rückgabe der abgefragten Profile eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/profile.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/projekte/{projekt_id}": { "get": { "tags": [ "projekte" ], "summary": "Abfrage eines einzelnen Projekts.", "description": "Rückgabe des abgefragten Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" } ], "responses": { "200": { "$ref": "#/responses/projekte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/projekte": { "get": { "tags": [ "projekte" ], "summary": "Abfrage von Projekten.", "description": "Rückgabe der abgefragten Projekte", "parameters": [ { "$ref": "#/parameters/projekte.projektstatus" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/projekte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/kunden/{kunden_id}/projekte": { "get": { "tags": [ "projekte" ], "summary": "Abfrage von Projekten zu einem Kunden.", "description": "Rückgabe der abgefragten Projekte eines Kunden. Hierbei werden die Projekte aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.projektstatus" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/projekte.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/termine/{termin_id}": { "get": { "tags": [ "termine" ], "summary": "Abfrage eines einzelnen Termins.", "description": "Rückgabe des abgefragten Termins.", "parameters": [ { "$ref": "#/parameters/termine.id" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/termine": { "get": { "tags": [ "termine" ], "summary": "Abfrage von Terminen", "description": "Rückgabe der abgefragten Termine", "parameters": [ { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/projekte/{projekt_id}/termine": { "get": { "tags": [ "termine" ], "summary": "Abfrage von Terminen zu einem Projekt.", "description": "Rückgabe der abgefragten Termine eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/jobs/{job_id}/termine": { "get": { "tags": [ "termine" ], "summary": "Abfrage von Terminen zu einem Job.", "description": "Rückgabe der abgefragten Termine eines Jobs.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/termine": { "get": { "tags": [ "termine" ], "summary": "Abfrage von Terminen zu einem Kunden.", "description": "Rückgabe der abgefragten Termine eines Kunden. Hierbei werden die Termine aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/projekte/{projekt_id}/termine": { "get": { "tags": [ "termine" ], "summary": "Abfrage von Terminen zu einem Projekt eines Kunden.", "description": "Rückgabe der abgefragten Termine zu einem Projekt eines Kunden. Hierbei werden die Termine aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kunden/{kunden_id}/jobs/{job_id}/termine": { "get": { "tags": [ "termine" ], "summary": "Abfrage von Terminen zu einem Job eines Kunden.", "description": "Rückgabe der abgefragten Termine zu einem Job eines Kunden. Hierbei werden die Termine aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/verfuegbarkeiten": { "get": { "tags": [ "verfuegbarkeiten" ], "summary": "Abfrage von Verfügbarkeiten.", "description": "Rückgabe der abgefragten Verfügbarkeiten", "parameters": [ { "$ref": "#/parameters/verfuegbarkeiten.verfuegbar" }, { "$ref": "#/parameters/verfuegbarkeiten.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/verfuegbarkeiten.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/profile/{profil_id}/verfuegbarkeiten": { "get": { "tags": [ "verfuegbarkeiten" ], "summary": "Abfrage von Verfügbarkeiten zu einem Profil.", "description": "Rückgabe der abgefragten Verfügbarkeiten eines Profils.", "parameters": [ { "$ref": "#/parameters/profile.id" }, { "$ref": "#/parameters/verfuegbarkeiten.verfuegbar" }, { "$ref": "#/parameters/verfuegbarkeiten.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/verfuegbarkeiten.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/job_feed/ipm": { "get": { "tags": [ "jobs" ], "summary": "Abfrage von Jobs.", "description": "Rückgabe der abgefragten Jobs", "parameters": [ { "$ref": "#/parameters/jobs.jobstatus" }, { "$ref": "#/parameters/suche" } ], "responses": { "200": { "$ref": "#/responses/jobs.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/kalender/termine/{termin_id}": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage eines einzelnen Termins.", "description": "Rückgabe des abgefragten Termins im iCal-Format.", "parameters": [ { "$ref": "#/parameters/termine.id" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" } } } }, "/kalender/termine": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage von Terminen", "description": "Rückgabe der abgefragten Termine im iCal-Format.", "parameters": [ { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" } } } }, "/kalender/projekte/{projekt_id}/termine": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage von Terminen zu einem Projekt im iCal-Format.", "description": "Rückgabe der abgefragten Termine eines Projekts.", "parameters": [ { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kalender/jobs/{job_id}/termine": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage von Terminen zu einem Job.", "description": "Rückgabe der abgefragten Termine eines Jobs im iCal-Format.", "parameters": [ { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kalender/kunden/{kunden_id}/termine": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage von Terminen zu einem Kunden.", "description": "Rückgabe der abgefragten Termine eines Kunden im iCal-Format. Hierbei werden die Termine aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kalender/kunden/{kunden_id}/projekte/{projekt_id}/termine": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage von Terminen zu einem Projekt eines Kunden.", "description": "Rückgabe der abgefragten Termine zu einem Projekt eines Kunden im iCal-Format. Hierbei werden die Termine aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/projekte.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } }, "/kalender/kunden/{kunden_id}/jobs/{job_id}/termine": { "get": { "tags": [ "kalender", "termine" ], "summary": "Abfrage von Terminen zu einem Job eines Kunden.", "description": "Rückgabe der abgefragten Termine zu einem Job eines Kunden im iCal-Format. Hierbei werden die Termine aus Kundensicht zurückgegeben, d.h. mit den Sichtbarkeitseinschränkungen die für den Kunden greifen.", "parameters": [ { "$ref": "#/parameters/kunden.id" }, { "$ref": "#/parameters/jobs.id" }, { "$ref": "#/parameters/termine.besetzungsstatus" }, { "$ref": "#/parameters/termine.zeitraum" } ], "responses": { "200": { "$ref": "#/responses/kalender.termine.200" }, "400": { "$ref": "#/responses/400" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404_id_nicht_gefunden" } } } } }, "definitions": { "Aktionsstandort Grunddaten": { "properties": { "aktionsstandortId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "aktionsstandortTitel": { "type": "string", "example": "Musterstandort" }, "aktionsstandortAdresszusatz": { "type": "string", "example": "Hinterhaus" }, "aktionsstandortStrasse": { "type": "string", "example": "Musterstraße 1" }, "aktionsstandortPLZ": { "type": "string", "example": "12345" }, "aktionsstandortStadt": { "type": "string", "example": "Musterstadt" }, "aktionsstandortLand": { "type": "string", "example": "Deutschland" }, "aktionsstandortIdentifikationsnummerIntern": { "type": "string", "example": "1000001" }, "aktionsstandortIdentifikationsnummerExtern": { "type": "string", "example": "ST-0001" }, "aktionsstandortBreitengrad": { "type": "number", "format": "float", "example": "52.000000", "x-nullable": true }, "aktionsstandortLaengengrad": { "type": "number", "format": "float", "example": "9.000000", "x-nullable": true } } }, "Aktionsstandort": { "properties": { "aktionsstandortId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "aktionsstandortTitel": { "type": "string", "example": "Musterstandort" }, "aktionsstandortAdresszusatz": { "type": "string", "example": "Hinterhaus" }, "aktionsstandortStrasse": { "type": "string", "example": "Musterstraße 1" }, "aktionsstandortPLZ": { "type": "string", "example": "12345" }, "aktionsstandortStadt": { "type": "string", "example": "Musterstadt" }, "aktionsstandortLand": { "type": "string", "example": "Deutschland" }, "aktionsstandortIdentifikationsnummerIntern": { "type": "string", "example": "1000001" }, "aktionsstandortIdentifikationsnummerExtern": { "type": "string", "example": "ST-0001" }, "aktionsstandortBreitengrad": { "type": "number", "format": "float", "example": "52.000000", "x-nullable": true }, "aktionsstandortLaengengrad": { "type": "number", "format": "float", "example": "9.000000", "x-nullable": true }, "aktionsstandortTelefonZentrale": { "type": "string", "example": "+49 000 0000000" }, "aktionsstandortFax": { "type": "string", "example": "+49 000 0000000" }, "aktionsstandortEmail": { "type": "string", "example": "standort@example.com" }, "aktionsstandortVorOrtKontakt1": { "type": "string", "example": "Max Muster" }, "aktionsstandortVorOrtTelefon1": { "type": "string", "example": "+49 000 0000000" }, "aktionsstandortVorOrtKontakt2": { "type": "string", "example": "Peter Später" }, "aktionsstandortVorOrtTelefon2": { "type": "string", "example": "+49 000 0000000" }, "aktionsstandortGebiete": { "type": "string", "example": "Gebiet 1 (12345), Gebiet 2 (45678)" }, "aktionsstandortInterneNotiz": { "type": "string", "example": "Ich bin die Notiz" }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" } } }, "Einsatz-Abrechnung": { "properties": { "einsatzAbrechnungId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "einsatzAbrechnungProfilId": { "type": "string", "format": "uuid", "example": "d5669b28-7600-4a8a-a803-8414cb268bc6" }, "einsatzAbrechnungProjektId": { "type": "string", "format": "uuid", "example": "f40dde61-b474-47a3-aa6c-eb58c64eb10d" }, "einsatzAbrechnungJobId": { "type": "string", "format": "uuid", "example": "fcfc8425-e27a-414d-8a4d-8814330d0230" }, "einsatzAbrechnungJobProfilId": { "type": "string", "format": "uuid", "example": "782839e3-5dee-41a8-8352-6b0c0d644a96" }, "einsatzAbrechnungTerminId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "einsatzAbrechnungEinsatzId": { "type": "string", "format": "uuid", "example": "d26d92ba-3b22-4d63-b0ef-da2f3921a000" }, "einsatzAbrechnungAktionsstandortId": { "type": "string", "format": "uuid", "example": "483774df-3ec0-469f-8449-98207243237f" }, "einsatzAbrechnungAbrechnungsstatus": { "type": "string", "example": "Abrechnung abgeschlossen" }, "einsatzAbrechnungWaehrung": { "type": "string", "example": "EUR" }, "einsatzAbrechnungEinkaufNettoGesamt": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStGesamt": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoGesamt": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoGesamt": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStGesamt": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoGesamt": { "type": "string", "example": "119,00" }, "einsatzAbrechnungEinkaufNettoGrundverguetung": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStGrundverguetung": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoGrundverguetung": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoGrundverguetung": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStGrundverguetung": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoGrundverguetung": { "type": "string", "example": "119,00" }, "einsatzAbrechnungEinkaufNettoPraemien": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStPraemien": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoPraemien": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoPraemien": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStPraemien": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoPraemien": { "type": "string", "example": "119,00" }, "einsatzAbrechnungEinkaufNettoProvisionen": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStProvisionen": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoProvisionen": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoProvisionen": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStProvisionen": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoProvisionen": { "type": "string", "example": "119,00" }, "einsatzAbrechnungEinkaufNettoFahrtkosten": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStFahrtkosten": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoFahrtkosten": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoFahrtkosten": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStFahrtkosten": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoFahrtkosten": { "type": "string", "example": "119,00" }, "einsatzAbrechnungEinkaufNettoAuslagen": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStAuslagen": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoAuslagen": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoAuslagen": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStAuslagen": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoAuslagen": { "type": "string", "example": "119,00" }, "einsatzAbrechnungEinkaufNettoSonstiges": { "type": "string", "example": "100,00" }, "einsatzAbrechnungEinkaufUStSonstiges": { "type": "string", "example": "19,00" }, "einsatzAbrechnungEinkaufBruttoSonstiges": { "type": "string", "example": "119,00" }, "einsatzAbrechnungVerkaufNettoSonstiges": { "type": "string", "example": "100,00" }, "einsatzAbrechnungVerkaufUStSonstiges": { "type": "string", "example": "19,00" }, "einsatzAbrechnungVerkaufBruttoSonstiges": { "type": "string", "example": "119,00" }, "einsatzAbrechnungPositionen": { "title": "Einsatz-Abrechnung-Position", "type": "array", "items": { "$ref": "#/definitions/Einsatz-Abrechnung-Position" } }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" }, "job": { "$ref": "#/definitions/Job Grunddaten" }, "termin": { "$ref": "#/definitions/Termin Grunddaten" }, "einsatz": { "$ref": "#/definitions/Einsatz" }, "aktionsstandort": { "$ref": "#/definitions/Aktionsstandort Grunddaten" }, "profil": { "$ref": "#/definitions/Profil Grunddaten" } } }, "Einsatz-Abrechnung-Position": { "properties": { "einsatzAbrechnungsPositionId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "einsatzAbrechnungsPositionTitel": { "type": "string", "example": "Tagessatz" }, "einsatzAbrechnungsPositionBeschreibung": { "type": "string", "example": "Freitext/Beschreibung vom Promoter" }, "einsatzAbrechnungsPositionBerechnungstyp": { "type": "string", "example": "Netto-Plan-Arbeitszeit pro Stunde" }, "einsatzAbrechnungsPositionKosteneinordnung": { "type": "string", "example": "Grundvergütung" }, "einsatzAbrechnungsPositionBerechnungInPlankosten": { "type": "string", "example": "Nein" }, "einsatzAbrechnungsPositionBerechnungInIstkosten": { "type": "string", "example": "Ja" }, "einsatzAbrechnungsPositionErloeskonto": { "type": "string", "example": "8400" }, "einsatzAbrechnungsPositionAufwandskonto": { "type": "string", "example": "1740" }, "einsatzAbrechnungsPositionKostenstelle": { "type": "string", "example": "1700" }, "einsatzAbrechnungsPositionKostentraeger": { "type": "string", "example": "1700" }, "einsatzAbrechnungsPositionLohnart": { "type": "string", "example": "11" }, "einsatzAbrechnungsPositionBearbeitungsschluessel": { "type": "string", "example": "3" }, "einsatzAbrechnungsPositionEinkaufAnzahl": { "type": "string", "example": "8,50" }, "einsatzAbrechnungsPositionEinkaufPreis": { "type": "string", "example": "10,00" }, "einsatzAbrechnungsPositionEinkaufSteuersatz": { "type": "string", "example": "USt. 19 %" }, "einsatzAbrechnungsPositionEinkaufEinheit": { "type": "string", "example": "pro Stunde" }, "einsatzAbrechnungsPositionEinkaufNetto": { "type": "string", "example": "85,00" }, "einsatzAbrechnungsPositionEinkaufUSt": { "type": "string", "example": "16,15" }, "einsatzAbrechnungsPositionEinkaufBrutto": { "type": "string", "example": "101,15" }, "einsatzAbrechnungsPositionVerkaufAnzahl": { "type": "string", "example": "8,50" }, "einsatzAbrechnungsPositionVerkaufPreis": { "type": "string", "example": "20,00" }, "einsatzAbrechnungsPositionVerkaufSteuersatz": { "type": "string", "example": "USt. 19 %" }, "einsatzAbrechnungsPositionVerkaufEinheit": { "type": "string", "example": "pro Stunde" }, "einsatzAbrechnungsPositionVerkaufNetto": { "type": "string", "example": "170,00" }, "einsatzAbrechnungsPositionVerkaufUSt": { "type": "string", "example": "32,30" }, "einsatzAbrechnungsPositionVerkaufBrutto": { "type": "string", "example": "202,30" } } }, "Einsatz": { "properties": { "einsatzId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "einsatzProjektId": { "type": "string", "format": "uuid", "example": "f40dde61-b474-47a3-aa6c-eb58c64eb10d" }, "einsatzJobId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "einsatzTerminId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "einsatzProfilId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "einsatzEinsatzstatus": { "type": "string", "example": "Einsatz wurde gebucht" }, "einsatzCheckIn": { "type": "string", "format": "date-time", "example": "10:00", "x-nullable": true }, "einsatzCheckOut": { "type": "string", "format": "date-time", "example": "20:00", "x-nullable": true }, "einsatzKategorien": { "type": "string", "example": "Kategorie A, Kategorie B" }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" }, "job": { "$ref": "#/definitions/Job Grunddaten" }, "termin": { "$ref": "#/definitions/Termin Grunddaten" }, "aktionsstandort": { "$ref": "#/definitions/Aktionsstandort Grunddaten" }, "profil": { "$ref": "#/definitions/Profil Grunddaten" } } }, "Feedback": { "properties": { "feedbackId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "feedbackFragebogenId": { "type": "string", "format": "uuid", "example": "f40dde61-b474-47a3-aa6c-eb58c64eb10d" }, "feedbackProfilId": { "type": "string", "format": "uuid", "example": "d5669b28-7600-4a8a-a803-8414cb268bc6" }, "feedbackProjektId": { "type": "string", "format": "uuid", "example": "f40dde61-b474-47a3-aa6c-eb58c64eb10d" }, "feedbackJobId": { "type": "string", "format": "uuid", "example": "fcfc8425-e27a-414d-8a4d-8814330d0230" }, "feedbackJobProfilId": { "type": "string", "format": "uuid", "example": "782839e3-5dee-41a8-8352-6b0c0d644a96" }, "feedbackTerminId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "feedbackEinsatzId": { "type": "string", "format": "uuid", "example": "d26d92ba-3b22-4d63-b0ef-da2f3921a000" }, "feedbackAktionsstandortId": { "type": "string", "format": "uuid", "example": "483774df-3ec0-469f-8449-98207243237f" }, "feedbackFragenAuswertungen": { "title": "Fragen-Auswertungen", "type": "array", "items": { "$ref": "#/definitions/Feedback-Fragen-Auswertung" } }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" }, "job": { "$ref": "#/definitions/Job Grunddaten" }, "termin": { "$ref": "#/definitions/Termin Grunddaten" }, "aktionsstandort": { "$ref": "#/definitions/Aktionsstandort Grunddaten" }, "profil": { "$ref": "#/definitions/Profil Grunddaten" }, "einsatz": { "$ref": "#/definitions/Einsatz" } } }, "Feedback-Fragen-Auswertung": { "properties": { "key": { "description": "Key der Feedback-Fragen-Auswertung-Collection abhängig von Titel der Frage-Elemente", "type": "string", "example": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id" }, "value": { "description": "Value der Feedback-Fragen-Auswertung-Collection mit dem Auswertungswert", "type": "string", "example": "5" } } }, "Job Grunddaten": { "properties": { "jobId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "jobName": { "type": "string", "example": "Verkostungsaktion" }, "jobNummer": { "type": "string", "example": "VK-2017-0123" } } }, "Job-Profil": { "properties": { "jobProfilId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "jobProfilProjektId": { "type": "string", "format": "uuid", "example": "f40dde61-b474-47a3-aa6c-eb58c64eb10d" }, "jobProfilJobId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "jobProfilProfilId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "jobProfilStatus": { "type": "string", "example": "Job-Profil wurde gebucht" }, "jobProfilAnzahlEinsaetze": { "type": "integer", "example": "5" }, "jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden": { "type": "integer", "example": "5" }, "jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter": { "type": "integer", "example": "5" }, "jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter": { "type": "integer", "example": "5" }, "jobProfilAnzahlEinsaetzAbgesagtDurchAgentur": { "type": "integer", "example": "5" }, "jobProfilAnzahlEinsaetzAbgesagtDurchPromoter": { "type": "integer", "example": "5" }, "jobProfilAnzahlEinsaetzeGebucht": { "type": "integer", "example": "5" }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" }, "job": { "$ref": "#/definitions/Job Grunddaten" }, "profil": { "$ref": "#/definitions/Profil Grunddaten" } } }, "Job": { "properties": { "jobId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "jobName": { "type": "string", "example": "Verkostungsaktion" }, "jobNummer": { "type": "string", "example": "VK-2017-0123" }, "jobAnzahlPersonalbedarf": { "type": "integer", "example": "1" }, "jobFunktionPersonalbedarf": { "type": "string", "example": "Promoter" }, "jobBeschreibungIntern": { "type": "string", "example": "Sondereinsätze für 2017" }, "jobStart": { "type": "string", "example": "01.01.2017" }, "jobEnde": { "type": "string", "example": "31.12.2017" }, "jobZeitVon": { "type": "string", "example": "10:00" }, "jobZeitBis": { "type": "string", "example": "20:00" }, "jobTitel": { "type": "string", "example": "Tolle Verkostungsaktion!" }, "jobBranche": { "type": "string", "example": "Lebensmittel" }, "jobTaetigkeit": { "type": "string", "example": "Verkostung" }, "jobKurzbeschreibung": { "type": "string", "example": "Nicht lange warten - jetzt bewerben!" }, "jobBeschreibung": { "type": "string", "example": "Bei dieser Aktion geht es um..." }, "jobZuordnungslink": { "type": "string", "example": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "jobKategorien": { "type": "string", "example": "Kategorie A, Kategorie B" }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" } } }, "Profil Grunddaten": { "properties": { "profilId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "profilVorname": { "type": "string", "example": "Max" }, "profilNachname": { "type": "string", "example": "Mustermann" }, "profilPersonalnummer": { "type": "string", "example": "P123456" }, "profilStatus": { "type": "string", "example": "aktiv" }, "profilEmail": { "type": "string", "format": "email", "example": "promoter@example.com" }, "profilMobil": { "type": "string", "example": "+49 000 0000000" } } }, "Profil": { "properties": { "profilId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "profilVorname": { "type": "string", "example": "Max" }, "profilNachname": { "type": "string", "example": "Mustermann" }, "profilPersonalnummer": { "type": "string", "example": "P123456" }, "profilStatus": { "type": "string", "example": "aktiv" }, "profilGeschlecht": { "type": "string", "example": "männlich" }, "profilEmail": { "type": "string", "format": "email", "example": "promoter@example.com" }, "profilMobil": { "type": "string", "example": "+49 000 0000000" }, "profilTelefonPrivat": { "type": "string", "example": "+49 000 0000000" }, "profilFax": { "type": "string", "example": "+49 000 0000000" }, "profilTelefonGeschaeftlich": { "type": "string", "example": "+49 000 0000000" }, "profilStrasse": { "type": "string", "example": "Musterstraße 1" }, "profilAdresszusatz": { "type": "string", "example": "Hinterhaus" }, "profilPLZ": { "type": "string", "example": "12345" }, "profilStadt": { "type": "string", "example": "Musterstadt" }, "profilLand": { "type": "string", "example": "Deutschland" }, "profilZweitanschriftStrasse": { "type": "string", "example": "Musterstraße 1" }, "profilZweitanschriftAdresszusatz": { "type": "string", "example": "Hinterhaus" }, "profilZweitanschriftPLZ": { "type": "string", "example": "12345" }, "profilZweitanschriftStadt": { "type": "string", "example": "Musterstadt" }, "profilZweitanschriftLand": { "type": "string", "example": "Deutschland" }, "profilInterneNotiz": { "type": "string", "example": "Ich bin die Notiz" }, "profilKategorien": { "type": "string", "example": "Kategorie A, Kategorie B" } } }, "Projekt Grunddaten": { "properties": { "projektId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "projektName": { "type": "string", "example": "Verkostungsaktion" }, "projektNummer": { "type": "string", "example": "VK-2017-0123" } } }, "Projekt": { "properties": { "projektId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "projektName": { "type": "string", "example": "Verkostungsaktion" }, "projektNummer": { "type": "string", "example": "VK-2017-0123" }, "projektAnzahlPersonalbedarf": { "type": "integer", "example": "1" }, "projektFunktionPersonalbedarf": { "type": "string", "example": "Promoter" }, "projektBeschreibungIntern": { "type": "string", "example": "Sondereinsätze für 2017" }, "projektStart": { "type": "string", "example": "01.01.2017" }, "projektEnde": { "type": "string", "example": "31.12.2017" }, "projektZeitVon": { "type": "string", "example": "10:00" }, "projektZeitBis": { "type": "string", "example": "20:00" }, "projektTitel": { "type": "string", "example": "Tolle Verkostungsaktion!" }, "projektBranche": { "type": "string", "example": "Lebensmittel" }, "projektTaetigkeit": { "type": "string", "example": "Verkostung" }, "projektKurzbeschreibung": { "type": "string", "example": "Nicht lange warten - jetzt bewerben!" }, "projektBeschreibung": { "type": "string", "example": "Bei dieser Aktion geht es um..." }, "projektKategorien": { "type": "string", "example": "Kategorie A, Kategorie B" } } }, "Termin Grunddaten": { "properties": { "terminId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "terminDatum": { "type": "string", "example": "02.07.2017" }, "terminZeitVon": { "type": "string", "example": "10:00" }, "terminZeitBis": { "type": "string", "example": "20:00" }, "terminBesetzungsstatus": { "type": "string", "example": "Termin ist unterbesetzt" }, "terminAnzahlPersonalbedarf": { "type": "integer", "example": "1" }, "terminFunktionPersonalbedarf": { "type": "string", "example": "Fachberater" } } }, "Termin": { "properties": { "terminId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "terminProjektId": { "type": "string", "format": "uuid", "example": "f40dde61-b474-47a3-aa6c-eb58c64eb10d" }, "terminJobId": { "type": "string", "format": "uuid", "example": "370b709f-5124-4dec-8c7f-0f54daf4c265" }, "terminDatum": { "type": "string", "example": "02.07.2017" }, "terminZeitVon": { "type": "string", "example": "10:00" }, "terminZeitBis": { "type": "string", "example": "20:00" }, "terminBesetzungsstatus": { "type": "string", "example": "Termin ist unterbesetzt" }, "terminAnzahlPersonalbedarf": { "type": "integer", "example": "1" }, "terminFunktionPersonalbedarf": { "type": "string", "example": "Fachberater" }, "terminKategorien": { "type": "string", "example": "Kategorie A, Kategorie B" }, "projekt": { "$ref": "#/definitions/Projekt Grunddaten" }, "job": { "$ref": "#/definitions/Job Grunddaten" }, "aktionsstandort": { "$ref": "#/definitions/Aktionsstandort Grunddaten" } } }, "Verfügbarkeit": { "properties": { "verfuegbarkeitId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "verfuegbarkeitProfilId": { "type": "string", "format": "uuid", "example": "d5669b28-7600-4a8a-a803-8414cb268bc6" }, "verfuegbarkeitDatum": { "type": "string", "example": "01.10.2018" }, "verfuegbarkeitVerfuegbar": { "type": "string", "example": "ja" }, "verfuegbarkeitNotiz": { "type": "string", "example": "Freitext der Notiz" }, "profil": { "$ref": "#/definitions/Profil Grunddaten" } } }, "IPMFeed": { "properties": { "jobId": { "type": "string", "format": "uuid", "example": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" }, "jobName": { "type": "string", "example": "Verkostungsaktion" }, "jobNummer": { "type": "string", "example": "VK-2017-0123" }, "jobAnzahlPersonalbedarf": { "type": "integer", "example": "1" }, "jobFunktionPersonalbedarf": { "type": "string", "example": "Promoter" }, "jobBeschreibungIntern": { "type": "string", "example": "Sondereinsätze für 2017" }, "jobStart": { "type": "string", "example": "01.01.2017" }, "jobEnde": { "type": "string", "example": "31.12.2017" }, "jobZeitVon": { "type": "string", "example": "10:00" }, "jobZeitBis": { "type": "string", "example": "20:00" }, "jobTitel": { "type": "string", "example": "Tolle Verkostungsaktion!" }, "jobBranche": { "type": "string", "example": "Lebensmittel" }, "jobTaetigkeit": { "type": "string", "example": "Verkostung" }, "jobKurzbeschreibung": { "type": "string", "example": "Nicht lange warten - jetzt bewerben!" }, "jobBeschreibung": { "type": "string", "example": "Bei dieser Aktion geht es um..." }, "jobZuordnungslink": { "type": "string", "example": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958" } } }, "Kalender.Termin": { "properties": { "summary": { "type": "string", "example": "Jobname (Jobnummer) | Aktionsstandort-Titel | Anzahl x Einsatzfunktion | [Besetzungsstatus] | [Termin wurde bestätigt] | [Termin wurde storniert]" }, "description": { "type": "string", "example": "Projekt: Projektname (Projektnummer) | Job: Jobname (Jobnummer) | Personalbedarf: Anzahl x Einsatzfunktion
Besetzungsstatus: Besetzungsstatus | Gebuchte Promoter: Max Mustermann, Erika Musterfrau | Kategorien: Kategorie 1, Kategorie 2 | Termin bestätigt: ja/nein" }, "location": { "type": "string", "example": "Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land" }, "dtstart": { "type": "string", "example": "20181001T080000Z" }, "dtend": { "type": "string", "example": "20181001T180000Z" }, "dtstamp": { "type": "string", "example": "20181001T180000Z" }, "dtcreated": { "type": "string", "example": "20181009T042127Z" }, "last-modified": { "type": "string", "example": "20181009T042127Z" } } } }, "parameters": { "einsaetze.einsatzstatus": { "name": "einsatzstatus", "in": "query", "description": "Filter nach dem Einsatzstatus der Einsätze. Mögliche Optionen des Parameters sind: angefragt, beworben, zugesagt und gebucht.", "required": false, "type": "string" }, "einsaetze.zeitraum": { "name": "zeitraum", "in": "query", "description": "Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.", "required": false, "type": "string" }, "einsatzabrechnungen.abrechnungsstatus": { "name": "abrechnungsstatus", "in": "query", "description": "Filter nach dem Abrechnungsstatus der Einsatz-Abrechnungen. Mögliche Optionen des Parameters sind: vorbereitet_durch_agentur, vorbereitet_durch_promoter, geändert_durch_agentur, geändert_durch_promoter, weitergeleitet_an_promoter, bestätigt_durch_promoter, abgelehnt_durch_agentur, abgeschlossen_durch_agentur.", "required": false, "type": "string" }, "einsatzabrechnungen.zeitraum": { "name": "zeitraum", "in": "query", "description": "Filter nach dem Zeitraum der Einsatz-Abrechnungen im Format dd.mm.yyyy-dd.mm.yyyy.", "required": false, "type": "string" }, "feedbacks.zeitraum": { "name": "zeitraum", "in": "query", "description": "Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.", "required": false, "type": "string" }, "jobProfile.jobprofilstatus": { "name": "jobprofilstatus", "in": "query", "description": "Filter nach dem Job-Profil-Status der Job-Profile. Mögliche Optionen des Parameters sind: angefragt, beworben, zugesagt und gebucht.", "required": false, "type": "string" }, "jobs.jobstatus": { "name": "jobstatus", "in": "query", "description": "Filter nach dem Status der Jobs. Mögliche Optionen des Parameters sind: aktiv, inaktiv, und abgeschlossen.", "required": false, "type": "string" }, "jobs.taetigkeit": { "name": "taetigkeit", "in": "query", "description": "Filter nach der Tätigkeit der Jobs aus den Ausschreibungsdaten. Mögliche Optionen des Parameters sind: A, B, und C.", "required": false, "type": "string" }, "jobs.mit_zuordnungslink": { "name": "mit_zuordnungslink", "in": "query", "description": "Filter nach Jobs bei denen die Bewerbung über den Zuordnungslink möglich ist.", "required": false, "type": "string" }, "projekte.projektstatus": { "name": "projektstatus", "in": "query", "description": "Filter nach dem Status der Projekte. Mögliche Optionen des Parameters sind: aktiv, inaktiv, und abgeschlossen.", "required": false, "type": "string" }, "termine.besetzungsstatus": { "name": "besetzungsstatus", "in": "query", "description": "Filter nach dem Besetzungsstatus der Termine. Mögliche Optionen des Parameters sind: besetzt, unterbesetzt, und überbesetzt.", "required": false, "type": "string" }, "termine.zeitraum": { "name": "zeitraum", "in": "query", "description": "Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.", "required": false, "type": "string" }, "verfuegbarkeiten.verfuegbar": { "name": "verfuegbar", "in": "query", "description": "Filter nach der Verfügbarkeit (ja/nein).", "required": false, "type": "string" }, "verfuegbarkeiten.zeitraum": { "name": "zeitraum", "in": "query", "description": "Filter nach dem Zeitraum der Verfügbarkeiten im Format dd.mm.yyyy-dd.mm.yyyy.", "required": false, "type": "string" }, "projekte.id": { "name": "projekt_id", "in": "path", "description": "UUID eines Projekts aus iPM_Promotion.", "required": true, "type": "string" }, "jobs.id": { "name": "job_id", "in": "path", "description": "UUID eines Jobs aus iPM_Promotion.", "required": true, "type": "string" }, "termine.id": { "name": "termin_id", "in": "path", "description": "UUID eines Termins aus iPM_Promotion.", "required": true, "type": "string" }, "einsaetze.id": { "name": "einsatz_id", "in": "path", "description": "UUID eines Einsatzes aus iPM_Promotion.", "required": true, "type": "string" }, "jobProfile.id": { "name": "jobprofil_id", "in": "path", "description": "UUID eines Job-Profils aus iPM_Promotion.", "required": true, "type": "string" }, "aktionsstandorte.id": { "name": "aktionsstandort_id", "in": "path", "description": "UUID eines Aktionsstandorts aus iPM_Promotion.", "required": true, "type": "string" }, "kunden.id": { "name": "kunden_id", "in": "path", "description": "UUID eines Kunden aus iPM_Promotion.", "required": true, "type": "string" }, "profile.id": { "name": "profil_id", "in": "path", "description": "UUID eines Profils aus iPM_Promotion.", "required": true, "type": "string" }, "feedbacks.id": { "name": "feedback_id", "in": "path", "description": "UUID eines Feedbacks aus iPM_Promotion.", "required": true, "type": "string" }, "frageboegen.id": { "name": "fragebogen_id", "in": "path", "description": "UUID eines Fragebogens aus iPM_Promotion.", "required": true, "type": "string" }, "einsatzabrechnungen.id": { "name": "einsatzabrechnung_id", "in": "path", "description": "UUID einer Einsatz-Abrechnung aus iPM_Promotion.", "required": true, "type": "string" }, "suche": { "name": "suche", "in": "query", "description": "Begriff für die Schnellsuche/Quicksearch.", "required": false, "type": "string" } }, "responses": { "400": { "description": "Userseitiger Fehler, z.B. falscher Input für Parameter" }, "403": { "description": "API-Key falsch oder nicht angegeben" }, "404": { "description": "Kein Ergebnis gefunden" }, "aktionsstandorte.200": { "description": "Rückgabe eines/mehrerer Aktionsstandorte", "schema": { "type": "array", "items": { "$ref": "#/definitions/Aktionsstandort" } } }, "einsaetze.200": { "description": "Rückgabe eines/mehrerer Einsätze", "schema": { "type": "array", "items": { "$ref": "#/definitions/Einsatz" } } }, "einsatzabrechnungen.200": { "description": "Rückgabe einer/mehrerer Einsatz-Abrechnungen", "schema": { "type": "array", "items": { "$ref": "#/definitions/Einsatz-Abrechnung" } } }, "feedbacks.200": { "description": "Rückgabe eines/mehrerer Feedbacks", "schema": { "type": "array", "items": { "$ref": "#/definitions/Feedback" } } }, "jobProfile.200": { "description": "Rückgabe eines/mehrerer Job-Profile", "schema": { "type": "array", "items": { "$ref": "#/definitions/Job-Profil" } } }, "jobs.200": { "description": "Rückgabe eines/mehrerer Jobs", "schema": { "type": "array", "items": { "$ref": "#/definitions/Job" } } }, "profile.200": { "description": "Rückgabe eines/mehrerer Profile", "schema": { "type": "array", "items": { "$ref": "#/definitions/Profil" } } }, "projekte.200": { "description": "Rückgabe eines/mehrerer Projekte", "schema": { "type": "array", "items": { "$ref": "#/definitions/Projekt" } } }, "termine.200": { "description": "Rückgabe eines/mehrerer Termine", "schema": { "type": "array", "items": { "$ref": "#/definitions/Termin" } } }, "verfuegbarkeiten.200": { "description": "Rückgabe eines/mehrerer Verfügbarkeiten", "schema": { "type": "array", "items": { "$ref": "#/definitions/Verfügbarkeit" } } }, "kalender.termine.200": { "description": "Rückgabe eines/mehrerer Termine", "schema": { "type": "array", "items": { "$ref": "#/definitions/Kalender.Termin" } } }, "404_id_nicht_gefunden": { "description": "Datensatz zu ID nicht gefunden" } }, "externalDocs": { "description": "Mehr Informationen zu iPM_Promotion!", "url": "http://ipm-promotion.de" }, "schemes": [ "https" ] }