API-Dokumentation

REST-API von iPM_Promotion: Daten aus Ihrem System abfragen, für eigene Auswertungen, Business-Intelligence-Tools und Schnittstellen.

Version 1 · Beta · Spezifikation Stand 2019Spezifikation als swagger.json

Inhalt

Basis-URL

Die API läuft auf der Adresse Ihres eigenen iPM_Promotion-Systems, die 1 steht für die Version. Der Termin-Endpunkt eines Systems unter promosoftware.de liegt zum Beispiel unter https://promosoftware.de/api/1/termine.

https://ihre-domain.de/api/1/

Endpunkt-Übersicht

Alle 61 Endpunkte lesen Daten (GET). Ein Klick auf den Pfad führt zu den Details.

Methode	Pfad	Beschreibung
Projekte
GET	/projekte/{projekt_id}	Abfrage eines einzelnen Projekts.
GET	/projekte	Abfrage von Projekten.
GET	/kunden/{kunden_id}/projekte	Abfrage von Projekten zu einem Kunden.
Jobs
GET	/jobs/{job_id}	Abfrage eines einzelnen Jobs.
GET	/jobs	Abfrage von Jobs.
GET	/projekte/{projekt_id}/jobs	Abfrage von Jobs zu einem Projekt.
GET	/kunden/{kunden_id}/jobs	Abfrage von Jobs zu einem Kunden.
GET	/kunden/{kunden_id}/projekte/{projekt_id}/jobs	Abfrage von Jobs zu einem Projekt eines Kunden.
GET	/job_feed/ipm	Abfrage von Jobs.
Termine
GET	/termine/{termin_id}	Abfrage eines einzelnen Termins.
GET	/termine	Abfrage von Terminen
GET	/projekte/{projekt_id}/termine	Abfrage von Terminen zu einem Projekt.
GET	/jobs/{job_id}/termine	Abfrage von Terminen zu einem Job.
GET	/kunden/{kunden_id}/termine	Abfrage von Terminen zu einem Kunden.
GET	/kunden/{kunden_id}/projekte/{projekt_id}/termine	Abfrage von Terminen zu einem Projekt eines Kunden.
GET	/kunden/{kunden_id}/jobs/{job_id}/termine	Abfrage von Terminen zu einem Job eines Kunden.
Einsätze
GET	/einsaetze/{einsatz_id}	Abfrage eines einzelnen Einsatzes.
GET	/einsaetze	Abfrage von Einsätzen.
GET	/profile/{profil_id}/einsaetze	Abfrage von Einsätzen zu einem Profil.
GET	/projekte/{projekt_id}/einsaetze	Abfrage von Einsätzen zu einem Projekt.
GET	/jobs/{job_id}/einsaetze	Abfrage von Einsätzen zu einem Job.
GET	/kunden/{kunden_id}/einsaetze	Abfrage von Einsätzen zu einem Kunden.
GET	/kunden/{kunden_id}/projekte/{projekt_id}/einsaetze	Abfrage von Einsätzen zu einem Projekt eines Kunden.
GET	/kunden/{kunden_id}/jobs/{job_id}/einsaetze	Abfrage von Einsätzen zu einem Job eines Kunden.
Aktionsstandorte
GET	/aktionsstandorte/{aktionsstandort_id}	Abfrage eines einzelnen Aktionsstandorts.
GET	/aktionsstandorte	Abfrage von Aktionsstandorten.
GET	/projekte/{projekt_id}/aktionsstandorte	Abfrage von Aktionsstandorten zu einem Projekt.
GET	/jobs/{job_id}/aktionsstandorte	Abfrage von Aktionsstandorten zu einem Job.
GET	/kunden/{kunden_id}/aktionsstandorte	Abfrage von Aktionsstandorten zu einem Kunden.
GET	/kunden/{kunden_id}/projekte/{projekt_id}/aktionsstandorte	Abfrage von Aktionsstandorten zu einem Projekt eines Kunden.
GET	/kunden/{kunden_id}/jobs/{job_id}/aktionsstandorte	Abfrage von Aktionsstandorten zu einem Job eines Kunden.
Profile
GET	/profile/{profil_id}	Abfrage eines einzelnen Profils.
GET	/profile	Abfrage von Profilen.
GET	/projekte/{projekt_id}/profile	Abfrage von Profilen zu einem Projekt.
GET	/jobs/{job_id}/profile	Abfrage von Profilen zu einem Job.
Job-Profile
GET	/jobprofile/{jobprofil_id}	Abfrage eines einzelnen Job-Profils.
GET	/jobprofile	Abfrage von Job-Profilen.
GET	/profile/{profil_id}/jobprofile	Abfrage von Job-Profilen zu einem Profil.
GET	/projekte/{projekt_id}/jobprofile	Abfrage von Job-Profilen zu einem Projekt.
GET	/jobs/{job_id}/jobprofile	Abfrage von Job-Profilen zu einem Job.
Verfügbarkeiten
GET	/verfuegbarkeiten	Abfrage von Verfügbarkeiten.
GET	/profile/{profil_id}/verfuegbarkeiten	Abfrage von Verfügbarkeiten zu einem Profil.
Feedbacks
GET	/feedbacks/{feedback_id}	Abfrage eines einzelnen Feedbacks.
GET	/frageboegen/{fragebogen_id}/feedbacks	Abfrage von Feedbacks zu einem Fragebogen.
GET	/projekte/{projekt_id}/frageboegen/{fragebogen_id}/feedbacks	Abfrage von Feedbacks zu einem Projekt und einem Fragebogen.
GET	/jobs/{job_id}/frageboegen/{fragebogen_id}/feedbacks	Abfrage von Feedbacks zu einem Job und einem Fragebogen.
GET	/kunden/{kunden_id}/frageboegen/{fragebogen_id}/feedbacks	Abfrage von Feedbacks zu einem Kunden und einem Fragebogen.
GET	/kunden/{kunden_id}/projekte/{projekt_id}/frageboegen/{fragebogen_id}/feedbacks	Abfrage von Feedbacks zu einem Kunden, einem Projekt und einem Fragebogen.
GET	/kunden/{kunden_id}/jobs/{job_id}/frageboegen/{fragebogen_id}/feedbacks	Abfrage von Feedbacks zu einem Kunden, einem Job und einem Fragebogen.
Einsatz-Abrechnungen
GET	/einsatzabrechnungen/{einsatzabrechnung_id}	Abfrage einer einzelnen Einsatz-Abrechnung.
GET	/einsatzabrechnungen	Abfrage von Einsatz-Abrechnungen.
GET	/projekte/{projekt_id}/einsatzabrechnungen	Abfrage von Einsatz-Abrechnungen zu einem Projekt.
GET	/jobs/{job_id}/einsatzabrechnungen	Abfrage von Einsatz-Abrechnungen zu einem Job.
GET	/profile/{profil_id}/einsatzabrechnungen	Abfrage von Einsatz-Abrechnungen zu einem Profil.
Kalender (iCal)
GET	/kalender/termine/{termin_id}	Abfrage eines einzelnen Termins.
GET	/kalender/termine	Abfrage von Terminen
GET	/kalender/projekte/{projekt_id}/termine	Abfrage von Terminen zu einem Projekt im iCal-Format.
GET	/kalender/jobs/{job_id}/termine	Abfrage von Terminen zu einem Job.
GET	/kalender/kunden/{kunden_id}/termine	Abfrage von Terminen zu einem Kunden.
GET	/kalender/kunden/{kunden_id}/projekte/{projekt_id}/termine	Abfrage von Terminen zu einem Projekt eines Kunden.
GET	/kalender/kunden/{kunden_id}/jobs/{job_id}/termine	Abfrage von Terminen zu einem Job eines Kunden.

1. Authentifizierung

1.1 API-Key erhalten

Jeder Zugriff braucht einen API-Key. Er gilt nur für Ihr iPM_Promotion-System. Den Key erhalten Sie in den Tarifen Premium und Enterprise auf Anfrage.

1.2 API-Key übermitteln

Als HTTP-Header api-key:

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte"

Oder als GET-Parameter api-key, etwa für Kalenderprogramme. Der Key steht dann in der Adresse und damit auch in Protokollen von Servern und Proxys:

https://ihre-domain.de/api/1/projekte?api-key=<api-key>

1.3 Fehlender oder falscher Key

Fehlt der Key oder ist er falsch, antwortet die API mit 403.

2. Konventionen

2.1 Rückgabeformate

Das Format legt die Endung des Pfads fest. Ohne Endung antwortet die API in JSON.

Endung oder Pfad	Format	Beispiel
keine, .json	JSON	/api/1/termine
.xml	XML	/api/1/termine.xml
kalender/…	iCal	/api/1/kalender/termine

https://ihre-domain.de/api/1/termine.xml

2.2 HTTP-Statuscodes

Code	Bedeutung
200	Rückgabe der abgefragten Daten
400	Userseitiger Fehler, z.B. falscher Input für Parameter
403	API-Key falsch oder nicht angegeben
404	Kein Ergebnis gefunden
404	Datensatz zu ID nicht gefunden

2.3 Limit und Offset

Eine Abfrage liefert höchstens 20.000 Datensätze. Größere Mengen holen Sie in Abschnitten.

Parameter	Bedeutung
limit	Anzahl der Datensätze, die zurückkommen, höchstens 20.000
offset	Ab welchem Datensatz die Rückgabe beginnt

https://ihre-domain.de/api/1/einsaetze?limit=500&offset=1000

2.4 Zeiträume

Filter nach Zeitraum erwarten das Format dd.mm.yyyy-dd.mm.yyyy, zum Beispiel zeitraum=01.07.2017-31.07.2017.

2.5 Grunddaten und erweiterte Daten

iPM_Promotion arbeitet mit hierarchischen Daten: Projekt, Job, Termin und Einsatz. Damit die Zuordnung möglich ist, enthalten etwa Termine und Einsätze auch die Grunddaten von Projekt und Job. Die vollständigen Daten liefert der Parameter erweiterteDaten, etwa für Projekt, Job und Aktionsstandort:

https://ihre-domain.de/api/1/termine?erweiterteDaten=projekt,job,aktionsstandort

Feedbacks enthalten zusätzlich die Fragen-Auswertungen, also alle Summen und Zählungen, die das System aus dem Fragebogen errechnet. Sie bilden sich dynamisch aus den Elementen des jeweiligen Fragebogens.

2.6 Stornierte Datensätze und Weiterentwicklung

Nur nicht stornierte Datensätze: Bei Projekten, Jobs, Terminen und Einsätzen gibt die API keine stornierten Datensätze zurück.

Beta: Änderungen sind möglich. Endpunkte und bestehende Eigenschaften sollen dabei nicht entfallen oder sich grundlegend ändern, neue Filter und Eigenschaften können hinzukommen.

3. Projekte

Projekte mit Titel, Nummer, Zeitraum, Personalbedarf, Branche und Beschreibungen.

GET`/projekte/{projekt_id}`

Abfrage eines einzelnen Projekts.

Abfrage eines einzelnen Projekts. Rückgabe des abgefragten Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Projekte: Liste von Projekt.

Feld	Typ	Beispiel
projektId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
projektName	string	Verkostungsaktion
projektNummer	string	VK-2017-0123
projektAnzahlPersonalbedarf	integer	1
projektFunktionPersonalbedarf	string	Promoter
projektBeschreibungIntern	string	Sondereinsätze für 2017
projektStart	string	01.01.2017
projektEnde	string	31.12.2017
projektZeitVon	string	10:00
projektZeitBis	string	20:00
projektTitel	string	Tolle Verkostungsaktion!
projektBranche	string	Lebensmittel
projektTaetigkeit	string	Verkostung
projektKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
projektBeschreibung	string	Bei dieser Aktion geht es um...
projektKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "projektName": "Verkostungsaktion",
    "projektNummer": "VK-2017-0123",
    "projektAnzahlPersonalbedarf": 1,
    "projektFunktionPersonalbedarf": "Promoter",
    "projektBeschreibungIntern": "Sondereinsätze für 2017",
    "projektStart": "01.01.2017",
    "projektEnde": "31.12.2017",
    "projektZeitVon": "10:00",
    "projektZeitBis": "20:00",
    "projektTitel": "Tolle Verkostungsaktion!",
    "projektBranche": "Lebensmittel",
    "projektTaetigkeit": "Verkostung",
    "projektKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "projektBeschreibung": "Bei dieser Aktion geht es um...",
    "projektKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/projekte`

Abfrage von Projekten.

Abfrage von Projekten. Rückgabe der abgefragten Projekte.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projektstatus	Abfrage	string	nein	Filter nach dem Status der Projekte. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte?projektstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Projekte: Liste von Projekt.

Feld	Typ	Beispiel
projektId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
projektName	string	Verkostungsaktion
projektNummer	string	VK-2017-0123
projektAnzahlPersonalbedarf	integer	1
projektFunktionPersonalbedarf	string	Promoter
projektBeschreibungIntern	string	Sondereinsätze für 2017
projektStart	string	01.01.2017
projektEnde	string	31.12.2017
projektZeitVon	string	10:00
projektZeitBis	string	20:00
projektTitel	string	Tolle Verkostungsaktion!
projektBranche	string	Lebensmittel
projektTaetigkeit	string	Verkostung
projektKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
projektBeschreibung	string	Bei dieser Aktion geht es um...
projektKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "projektName": "Verkostungsaktion",
    "projektNummer": "VK-2017-0123",
    "projektAnzahlPersonalbedarf": 1,
    "projektFunktionPersonalbedarf": "Promoter",
    "projektBeschreibungIntern": "Sondereinsätze für 2017",
    "projektStart": "01.01.2017",
    "projektEnde": "31.12.2017",
    "projektZeitVon": "10:00",
    "projektZeitBis": "20:00",
    "projektTitel": "Tolle Verkostungsaktion!",
    "projektBranche": "Lebensmittel",
    "projektTaetigkeit": "Verkostung",
    "projektKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "projektBeschreibung": "Bei dieser Aktion geht es um...",
    "projektKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/kunden/{kunden_id}/projekte`

Abfrage von Projekten zu einem Kunden.

Abfrage von Projekten zu einem Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projektstatus	Abfrage	string	nein	Filter nach dem Status der Projekte. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/projekte?projektstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Projekte: Liste von Projekt.

Feld	Typ	Beispiel
projektId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
projektName	string	Verkostungsaktion
projektNummer	string	VK-2017-0123
projektAnzahlPersonalbedarf	integer	1
projektFunktionPersonalbedarf	string	Promoter
projektBeschreibungIntern	string	Sondereinsätze für 2017
projektStart	string	01.01.2017
projektEnde	string	31.12.2017
projektZeitVon	string	10:00
projektZeitBis	string	20:00
projektTitel	string	Tolle Verkostungsaktion!
projektBranche	string	Lebensmittel
projektTaetigkeit	string	Verkostung
projektKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
projektBeschreibung	string	Bei dieser Aktion geht es um...
projektKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "projektName": "Verkostungsaktion",
    "projektNummer": "VK-2017-0123",
    "projektAnzahlPersonalbedarf": 1,
    "projektFunktionPersonalbedarf": "Promoter",
    "projektBeschreibungIntern": "Sondereinsätze für 2017",
    "projektStart": "01.01.2017",
    "projektEnde": "31.12.2017",
    "projektZeitVon": "10:00",
    "projektZeitBis": "20:00",
    "projektTitel": "Tolle Verkostungsaktion!",
    "projektBranche": "Lebensmittel",
    "projektTaetigkeit": "Verkostung",
    "projektKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "projektBeschreibung": "Bei dieser Aktion geht es um...",
    "projektKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

4. Jobs

Jobs mit den Daten der Ausschreibung, dem Personalbedarf und dem Zuordnungslink.

GET`/jobs/{job_id}`

Abfrage eines einzelnen Jobs.

Abfrage eines einzelnen Jobs. Rückgabe des abgefragten Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Jobs: Liste von Job.

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobName": "Verkostungsaktion",
    "jobNummer": "VK-2017-0123",
    "jobAnzahlPersonalbedarf": 1,
    "jobFunktionPersonalbedarf": "Promoter",
    "jobBeschreibungIntern": "Sondereinsätze für 2017",
    "jobStart": "01.01.2017",
    "jobEnde": "31.12.2017",
    "jobZeitVon": "10:00",
    "jobZeitBis": "20:00",
    "jobTitel": "Tolle Verkostungsaktion!",
    "jobBranche": "Lebensmittel",
    "jobTaetigkeit": "Verkostung",
    "jobKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "jobBeschreibung": "Bei dieser Aktion geht es um...",
    "jobZuordnungslink": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/jobs`

Abfrage von Jobs.

Abfrage von Jobs. Rückgabe der abgefragten Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
jobstatus	Abfrage	string	nein	Filter nach dem Status der Jobs. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
taetigkeit	Abfrage	string	nein	Filter nach der Tätigkeit der Jobs aus den Ausschreibungsdaten. Beispielwerte laut Spezifikation: `A`, `B`, `C`
mit_zuordnungslink	Abfrage	string	nein	Filter nach Jobs bei denen die Bewerbung über den Zuordnungslink möglich ist.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs?jobstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Jobs: Liste von Job.

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobName": "Verkostungsaktion",
    "jobNummer": "VK-2017-0123",
    "jobAnzahlPersonalbedarf": 1,
    "jobFunktionPersonalbedarf": "Promoter",
    "jobBeschreibungIntern": "Sondereinsätze für 2017",
    "jobStart": "01.01.2017",
    "jobEnde": "31.12.2017",
    "jobZeitVon": "10:00",
    "jobZeitBis": "20:00",
    "jobTitel": "Tolle Verkostungsaktion!",
    "jobBranche": "Lebensmittel",
    "jobTaetigkeit": "Verkostung",
    "jobKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "jobBeschreibung": "Bei dieser Aktion geht es um...",
    "jobZuordnungslink": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/projekte/{projekt_id}/jobs`

Abfrage von Jobs zu einem Projekt.

Abfrage von Jobs zu einem Projekt. Rückgabe der abgefragten Jobs eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
jobstatus	Abfrage	string	nein	Filter nach dem Status der Jobs. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
taetigkeit	Abfrage	string	nein	Filter nach der Tätigkeit der Jobs aus den Ausschreibungsdaten. Beispielwerte laut Spezifikation: `A`, `B`, `C`
mit_zuordnungslink	Abfrage	string	nein	Filter nach Jobs bei denen die Bewerbung über den Zuordnungslink möglich ist.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/jobs?jobstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Jobs: Liste von Job.

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobName": "Verkostungsaktion",
    "jobNummer": "VK-2017-0123",
    "jobAnzahlPersonalbedarf": 1,
    "jobFunktionPersonalbedarf": "Promoter",
    "jobBeschreibungIntern": "Sondereinsätze für 2017",
    "jobStart": "01.01.2017",
    "jobEnde": "31.12.2017",
    "jobZeitVon": "10:00",
    "jobZeitBis": "20:00",
    "jobTitel": "Tolle Verkostungsaktion!",
    "jobBranche": "Lebensmittel",
    "jobTaetigkeit": "Verkostung",
    "jobKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "jobBeschreibung": "Bei dieser Aktion geht es um...",
    "jobZuordnungslink": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/jobs`

Abfrage von Jobs zu einem Kunden.

Abfrage von Jobs zu einem Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
jobstatus	Abfrage	string	nein	Filter nach dem Status der Jobs. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
taetigkeit	Abfrage	string	nein	Filter nach der Tätigkeit der Jobs aus den Ausschreibungsdaten. Beispielwerte laut Spezifikation: `A`, `B`, `C`
mit_zuordnungslink	Abfrage	string	nein	Filter nach Jobs bei denen die Bewerbung über den Zuordnungslink möglich ist.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/jobs?jobstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Jobs: Liste von Job.

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobName": "Verkostungsaktion",
    "jobNummer": "VK-2017-0123",
    "jobAnzahlPersonalbedarf": 1,
    "jobFunktionPersonalbedarf": "Promoter",
    "jobBeschreibungIntern": "Sondereinsätze für 2017",
    "jobStart": "01.01.2017",
    "jobEnde": "31.12.2017",
    "jobZeitVon": "10:00",
    "jobZeitBis": "20:00",
    "jobTitel": "Tolle Verkostungsaktion!",
    "jobBranche": "Lebensmittel",
    "jobTaetigkeit": "Verkostung",
    "jobKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "jobBeschreibung": "Bei dieser Aktion geht es um...",
    "jobZuordnungslink": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/projekte/{projekt_id}/jobs`

Abfrage von Jobs zu einem Projekt eines Kunden.

Abfrage von Jobs zu einem Projekt eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
jobstatus	Abfrage	string	nein	Filter nach dem Status der Jobs. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
taetigkeit	Abfrage	string	nein	Filter nach der Tätigkeit der Jobs aus den Ausschreibungsdaten. Beispielwerte laut Spezifikation: `A`, `B`, `C`
mit_zuordnungslink	Abfrage	string	nein	Filter nach Jobs bei denen die Bewerbung über den Zuordnungslink möglich ist.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/jobs?jobstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Jobs: Liste von Job.

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobName": "Verkostungsaktion",
    "jobNummer": "VK-2017-0123",
    "jobAnzahlPersonalbedarf": 1,
    "jobFunktionPersonalbedarf": "Promoter",
    "jobBeschreibungIntern": "Sondereinsätze für 2017",
    "jobStart": "01.01.2017",
    "jobEnde": "31.12.2017",
    "jobZeitVon": "10:00",
    "jobZeitBis": "20:00",
    "jobTitel": "Tolle Verkostungsaktion!",
    "jobBranche": "Lebensmittel",
    "jobTaetigkeit": "Verkostung",
    "jobKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "jobBeschreibung": "Bei dieser Aktion geht es um...",
    "jobZuordnungslink": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/job_feed/ipm`

Abfrage von Jobs.

Abfrage von Jobs. Rückgabe der abgefragten Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
jobstatus	Abfrage	string	nein	Filter nach dem Status der Jobs. Werte: `aktiv`, `inaktiv`, `abgeschlossen`
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/job_feed/ipm?jobstatus=aktiv"

Antwort 200

Rückgabe eines/mehrerer Jobs: Liste von Job.

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobName": "Verkostungsaktion",
    "jobNummer": "VK-2017-0123",
    "jobAnzahlPersonalbedarf": 1,
    "jobFunktionPersonalbedarf": "Promoter",
    "jobBeschreibungIntern": "Sondereinsätze für 2017",
    "jobStart": "01.01.2017",
    "jobEnde": "31.12.2017",
    "jobZeitVon": "10:00",
    "jobZeitBis": "20:00",
    "jobTitel": "Tolle Verkostungsaktion!",
    "jobBranche": "Lebensmittel",
    "jobTaetigkeit": "Verkostung",
    "jobKurzbeschreibung": "Nicht lange warten - jetzt bewerben!",
    "jobBeschreibung": "Bei dieser Aktion geht es um...",
    "jobZuordnungslink": "http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

5. Termine

Termine mit Datum, Uhrzeit, Personalbedarf und Besetzungsstatus.

GET`/termine/{termin_id}`

Abfrage eines einzelnen Termins.

Abfrage eines einzelnen Termins. Rückgabe des abgefragten Termins.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
termin_id	Pfad	string	ja	UUID eines Termins aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/termine/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/termine`

Abfrage von Terminen

Abfrage von Terminen. Rückgabe der abgefragten Termine.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/termine?besetzungsstatus=besetzt"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/projekte/{projekt_id}/termine`

Abfrage von Terminen zu einem Projekt.

Abfrage von Terminen zu einem Projekt. Rückgabe der abgefragten Termine eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?besetzungsstatus=besetzt"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/jobs/{job_id}/termine`

Abfrage von Terminen zu einem Job.

Abfrage von Terminen zu einem Job. Rückgabe der abgefragten Termine eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?besetzungsstatus=besetzt"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/termine`

Abfrage von Terminen zu einem Kunden.

Abfrage von Terminen zu einem Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/termine?besetzungsstatus=besetzt"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/projekte/{projekt_id}/termine`

Abfrage von Terminen zu einem Projekt eines Kunden.

Abfrage von Terminen zu einem Projekt eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?besetzungsstatus=besetzt"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/jobs/{job_id}/termine`

Abfrage von Terminen zu einem Job eines Kunden.

Abfrage von Terminen zu einem Job eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?besetzungsstatus=besetzt"

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Termin.

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "terminProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "terminJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "terminDatum": "02.07.2017",
    "terminZeitVon": "10:00",
    "terminZeitBis": "20:00",
    "terminBesetzungsstatus": "Termin ist unterbesetzt",
    "terminAnzahlPersonalbedarf": 1,
    "terminFunktionPersonalbedarf": "Fachberater",
    "terminKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

6. Einsätze

Einsätze der Promoter auf Terminen mit Status, Check-in und Check-out.

GET`/einsaetze/{einsatz_id}`

Abfrage eines einzelnen Einsatzes.

Abfrage eines einzelnen Einsatzes. Rückgabe des abgefragten Einsatzes.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
einsatz_id	Pfad	string	ja	UUID eines Einsatzes aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/einsaetze/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/einsaetze`

Abfrage von Einsätzen.

Abfrage von Einsätzen. Rückgabe der abgefragten Einsätze.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/profile/{profil_id}/einsaetze`

Abfrage von Einsätzen zu einem Profil.

Abfrage von Einsätzen zu einem Profil. Rückgabe der abgefragten Einsätze eines Profils.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
profil_id	Pfad	string	ja	UUID eines Profils aus iPM_Promotion.
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/profile/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/projekte/{projekt_id}/einsaetze`

Abfrage von Einsätzen zu einem Projekt.

Abfrage von Einsätzen zu einem Projekt. Rückgabe der abgefragten Einsätze eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/jobs/{job_id}/einsaetze`

Abfrage von Einsätzen zu einem Job.

Abfrage von Einsätzen zu einem Job. Rückgabe der abgefragten Einsätze eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/einsaetze`

Abfrage von Einsätzen zu einem Kunden.

Abfrage von Einsätzen zu einem Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/projekte/{projekt_id}/einsaetze`

Abfrage von Einsätzen zu einem Projekt eines Kunden.

Abfrage von Einsätzen zu einem Projekt eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/jobs/{job_id}/einsaetze`

Abfrage von Einsätzen zu einem Job eines Kunden.

Abfrage von Einsätzen zu einem Job eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
einsatzstatus	Abfrage	string	nein	Filter nach dem Einsatzstatus der Einsätze. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsätze im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsaetze?einsatzstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Einsätze: Liste von Einsatz.

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzEinsatzstatus": "Einsatz wurde gebucht",
    "einsatzCheckIn": "10:00",
    "einsatzCheckOut": "20:00",
    "einsatzKategorien": "Kategorie A, Kategorie B",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

7. Aktionsstandorte

Standorte mit Adresse, Koordinaten und Kontakten vor Ort.

GET`/aktionsstandorte/{aktionsstandort_id}`

Abfrage eines einzelnen Aktionsstandorts.

Abfrage eines einzelnen Aktionsstandorts. Rückgabe des abgefragten Aktionsstandorts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
aktionsstandort_id	Pfad	string	ja	UUID eines Aktionsstandorts aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/aktionsstandorte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/aktionsstandorte`

Abfrage von Aktionsstandorten.

Abfrage von Aktionsstandorten. Rückgabe der abgefragten Aktionsstandorte.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/aktionsstandorte"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/projekte/{projekt_id}/aktionsstandorte`

Abfrage von Aktionsstandorten zu einem Projekt.

Abfrage von Aktionsstandorten zu einem Projekt. Rückgabe der abgefragten Aktionsstandorte eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/aktionsstandorte"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/jobs/{job_id}/aktionsstandorte`

Abfrage von Aktionsstandorten zu einem Job.

Abfrage von Aktionsstandorten zu einem Job. Rückgabe der abgefragten Aktionsstandorte eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/aktionsstandorte"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/aktionsstandorte`

Abfrage von Aktionsstandorten zu einem Kunden.

Abfrage von Aktionsstandorten zu einem Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/aktionsstandorte"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/projekte/{projekt_id}/aktionsstandorte`

Abfrage von Aktionsstandorten zu einem Projekt eines Kunden.

Abfrage von Aktionsstandorten zu einem Projekt eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/aktionsstandorte"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kunden/{kunden_id}/jobs/{job_id}/aktionsstandorte`

Abfrage von Aktionsstandorten zu einem Job eines Kunden.

Abfrage von Aktionsstandorten zu einem Job eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/aktionsstandorte"

Antwort 200

Rückgabe eines/mehrerer Aktionsstandorte: Liste von Aktionsstandort.

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "aktionsstandortTitel": "Musterstandort",
    "aktionsstandortAdresszusatz": "Hinterhaus",
    "aktionsstandortStrasse": "Musterstraße 1",
    "aktionsstandortPLZ": "12345",
    "aktionsstandortStadt": "Musterstadt",
    "aktionsstandortLand": "Deutschland",
    "aktionsstandortIdentifikationsnummerIntern": "1000001",
    "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
    "aktionsstandortBreitengrad": "52.000000",
    "aktionsstandortLaengengrad": "9.000000",
    "aktionsstandortTelefonZentrale": "+49 000 0000000",
    "aktionsstandortFax": "+49 000 0000000",
    "aktionsstandortEmail": "standort@example.com",
    "aktionsstandortVorOrtKontakt1": "Max Muster",
    "aktionsstandortVorOrtTelefon1": "+49 000 0000000",
    "aktionsstandortVorOrtKontakt2": "Peter Später",
    "aktionsstandortVorOrtTelefon2": "+49 000 0000000",
    "aktionsstandortGebiete": "Gebiet 1 (12345), Gebiet 2 (45678)",
    "aktionsstandortInterneNotiz": "Ich bin die Notiz",
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

8. Profile

Profile der Promoter mit Status, Kontaktdaten und Anschriften.

GET`/profile/{profil_id}`

Abfrage eines einzelnen Profils.

Abfrage eines einzelnen Profils. Rückgabe des abgefragten Profils.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
profil_id	Pfad	string	ja	UUID eines Profils aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/profile/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Profile: Liste von Profil.

Feld	Typ	Beispiel
profilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
profilVorname	string	Max
profilNachname	string	Mustermann
profilPersonalnummer	string	P123456
profilStatus	string	aktiv
profilGeschlecht	string	männlich
profilEmail	email	promoter@example.com
profilMobil	string	+49 000 0000000
profilTelefonPrivat	string	+49 000 0000000
profilFax	string	+49 000 0000000
profilTelefonGeschaeftlich	string	+49 000 0000000
profilStrasse	string	Musterstraße 1
profilAdresszusatz	string	Hinterhaus
profilPLZ	string	12345
profilStadt	string	Musterstadt
profilLand	string	Deutschland
profilZweitanschriftStrasse	string	Musterstraße 1
profilZweitanschriftAdresszusatz	string	Hinterhaus
profilZweitanschriftPLZ	string	12345
profilZweitanschriftStadt	string	Musterstadt
profilZweitanschriftLand	string	Deutschland
profilInterneNotiz	string	Ich bin die Notiz
profilKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "profilVorname": "Max",
    "profilNachname": "Mustermann",
    "profilPersonalnummer": "P123456",
    "profilStatus": "aktiv",
    "profilGeschlecht": "männlich",
    "profilEmail": "promoter@example.com",
    "profilMobil": "+49 000 0000000",
    "profilTelefonPrivat": "+49 000 0000000",
    "profilFax": "+49 000 0000000",
    "profilTelefonGeschaeftlich": "+49 000 0000000",
    "profilStrasse": "Musterstraße 1",
    "profilAdresszusatz": "Hinterhaus",
    "profilPLZ": "12345",
    "profilStadt": "Musterstadt",
    "profilLand": "Deutschland",
    "profilZweitanschriftStrasse": "Musterstraße 1",
    "profilZweitanschriftAdresszusatz": "Hinterhaus",
    "profilZweitanschriftPLZ": "12345",
    "profilZweitanschriftStadt": "Musterstadt",
    "profilZweitanschriftLand": "Deutschland",
    "profilInterneNotiz": "Ich bin die Notiz",
    "profilKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/profile`

Abfrage von Profilen.

Abfrage von Profilen. Rückgabe der abgefragten Profile.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/profile"

Antwort 200

Rückgabe eines/mehrerer Profile: Liste von Profil.

Feld	Typ	Beispiel
profilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
profilVorname	string	Max
profilNachname	string	Mustermann
profilPersonalnummer	string	P123456
profilStatus	string	aktiv
profilGeschlecht	string	männlich
profilEmail	email	promoter@example.com
profilMobil	string	+49 000 0000000
profilTelefonPrivat	string	+49 000 0000000
profilFax	string	+49 000 0000000
profilTelefonGeschaeftlich	string	+49 000 0000000
profilStrasse	string	Musterstraße 1
profilAdresszusatz	string	Hinterhaus
profilPLZ	string	12345
profilStadt	string	Musterstadt
profilLand	string	Deutschland
profilZweitanschriftStrasse	string	Musterstraße 1
profilZweitanschriftAdresszusatz	string	Hinterhaus
profilZweitanschriftPLZ	string	12345
profilZweitanschriftStadt	string	Musterstadt
profilZweitanschriftLand	string	Deutschland
profilInterneNotiz	string	Ich bin die Notiz
profilKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "profilVorname": "Max",
    "profilNachname": "Mustermann",
    "profilPersonalnummer": "P123456",
    "profilStatus": "aktiv",
    "profilGeschlecht": "männlich",
    "profilEmail": "promoter@example.com",
    "profilMobil": "+49 000 0000000",
    "profilTelefonPrivat": "+49 000 0000000",
    "profilFax": "+49 000 0000000",
    "profilTelefonGeschaeftlich": "+49 000 0000000",
    "profilStrasse": "Musterstraße 1",
    "profilAdresszusatz": "Hinterhaus",
    "profilPLZ": "12345",
    "profilStadt": "Musterstadt",
    "profilLand": "Deutschland",
    "profilZweitanschriftStrasse": "Musterstraße 1",
    "profilZweitanschriftAdresszusatz": "Hinterhaus",
    "profilZweitanschriftPLZ": "12345",
    "profilZweitanschriftStadt": "Musterstadt",
    "profilZweitanschriftLand": "Deutschland",
    "profilInterneNotiz": "Ich bin die Notiz",
    "profilKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/projekte/{projekt_id}/profile`

Abfrage von Profilen zu einem Projekt.

Abfrage von Profilen zu einem Projekt. Rückgabe der abgefragten Profile eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/profile"

Antwort 200

Rückgabe eines/mehrerer Profile: Liste von Profil.

Feld	Typ	Beispiel
profilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
profilVorname	string	Max
profilNachname	string	Mustermann
profilPersonalnummer	string	P123456
profilStatus	string	aktiv
profilGeschlecht	string	männlich
profilEmail	email	promoter@example.com
profilMobil	string	+49 000 0000000
profilTelefonPrivat	string	+49 000 0000000
profilFax	string	+49 000 0000000
profilTelefonGeschaeftlich	string	+49 000 0000000
profilStrasse	string	Musterstraße 1
profilAdresszusatz	string	Hinterhaus
profilPLZ	string	12345
profilStadt	string	Musterstadt
profilLand	string	Deutschland
profilZweitanschriftStrasse	string	Musterstraße 1
profilZweitanschriftAdresszusatz	string	Hinterhaus
profilZweitanschriftPLZ	string	12345
profilZweitanschriftStadt	string	Musterstadt
profilZweitanschriftLand	string	Deutschland
profilInterneNotiz	string	Ich bin die Notiz
profilKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "profilVorname": "Max",
    "profilNachname": "Mustermann",
    "profilPersonalnummer": "P123456",
    "profilStatus": "aktiv",
    "profilGeschlecht": "männlich",
    "profilEmail": "promoter@example.com",
    "profilMobil": "+49 000 0000000",
    "profilTelefonPrivat": "+49 000 0000000",
    "profilFax": "+49 000 0000000",
    "profilTelefonGeschaeftlich": "+49 000 0000000",
    "profilStrasse": "Musterstraße 1",
    "profilAdresszusatz": "Hinterhaus",
    "profilPLZ": "12345",
    "profilStadt": "Musterstadt",
    "profilLand": "Deutschland",
    "profilZweitanschriftStrasse": "Musterstraße 1",
    "profilZweitanschriftAdresszusatz": "Hinterhaus",
    "profilZweitanschriftPLZ": "12345",
    "profilZweitanschriftStadt": "Musterstadt",
    "profilZweitanschriftLand": "Deutschland",
    "profilInterneNotiz": "Ich bin die Notiz",
    "profilKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/jobs/{job_id}/profile`

Abfrage von Profilen zu einem Job.

Abfrage von Profilen zu einem Job. Rückgabe der abgefragten Profile eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
suche	Abfrage	string	nein	Begriff für die Schnellsuche/Quicksearch.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/profile"

Antwort 200

Rückgabe eines/mehrerer Profile: Liste von Profil.

Feld	Typ	Beispiel
profilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
profilVorname	string	Max
profilNachname	string	Mustermann
profilPersonalnummer	string	P123456
profilStatus	string	aktiv
profilGeschlecht	string	männlich
profilEmail	email	promoter@example.com
profilMobil	string	+49 000 0000000
profilTelefonPrivat	string	+49 000 0000000
profilFax	string	+49 000 0000000
profilTelefonGeschaeftlich	string	+49 000 0000000
profilStrasse	string	Musterstraße 1
profilAdresszusatz	string	Hinterhaus
profilPLZ	string	12345
profilStadt	string	Musterstadt
profilLand	string	Deutschland
profilZweitanschriftStrasse	string	Musterstraße 1
profilZweitanschriftAdresszusatz	string	Hinterhaus
profilZweitanschriftPLZ	string	12345
profilZweitanschriftStadt	string	Musterstadt
profilZweitanschriftLand	string	Deutschland
profilInterneNotiz	string	Ich bin die Notiz
profilKategorien	string	Kategorie A, Kategorie B

Beispielantwort 200

[
  {
    "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "profilVorname": "Max",
    "profilNachname": "Mustermann",
    "profilPersonalnummer": "P123456",
    "profilStatus": "aktiv",
    "profilGeschlecht": "männlich",
    "profilEmail": "promoter@example.com",
    "profilMobil": "+49 000 0000000",
    "profilTelefonPrivat": "+49 000 0000000",
    "profilFax": "+49 000 0000000",
    "profilTelefonGeschaeftlich": "+49 000 0000000",
    "profilStrasse": "Musterstraße 1",
    "profilAdresszusatz": "Hinterhaus",
    "profilPLZ": "12345",
    "profilStadt": "Musterstadt",
    "profilLand": "Deutschland",
    "profilZweitanschriftStrasse": "Musterstraße 1",
    "profilZweitanschriftAdresszusatz": "Hinterhaus",
    "profilZweitanschriftPLZ": "12345",
    "profilZweitanschriftStadt": "Musterstadt",
    "profilZweitanschriftLand": "Deutschland",
    "profilInterneNotiz": "Ich bin die Notiz",
    "profilKategorien": "Kategorie A, Kategorie B"
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

9. Job-Profile

Zuordnung von Profilen zu Jobs mit Status und der Anzahl der Einsätze je Stand.

GET`/jobprofile/{jobprofil_id}`

Abfrage eines einzelnen Job-Profils.

Abfrage eines einzelnen Job-Profils. Rückgabe des abgefragten Job-Profils.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
jobprofil_id	Pfad	string	ja	UUID eines Job-Profils aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobprofile/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Job-Profile: Liste von Job-Profil.

Feld	Typ	Beispiel
jobProfilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobProfilProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
jobProfilJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilStatus	string	Job-Profil wurde gebucht
jobProfilAnzahlEinsaetze	integer	5
jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden	integer	5
jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter	integer	5
jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchAgentur	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchPromoter	integer	5
jobProfilAnzahlEinsaetzeGebucht	integer	5
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobProfilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobProfilProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "jobProfilJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilStatus": "Job-Profil wurde gebucht",
    "jobProfilAnzahlEinsaetze": 5,
    "jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden": 5,
    "jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter": 5,
    "jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchAgentur": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzeGebucht": 5,
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/jobprofile`

Abfrage von Job-Profilen.

Abfrage von Job-Profilen. Rückgabe der abgefragten Job-Profile.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
jobprofilstatus	Abfrage	string	nein	Filter nach dem Job-Profil-Status der Job-Profile. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobprofile?jobprofilstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Job-Profile: Liste von Job-Profil.

Feld	Typ	Beispiel
jobProfilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobProfilProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
jobProfilJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilStatus	string	Job-Profil wurde gebucht
jobProfilAnzahlEinsaetze	integer	5
jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden	integer	5
jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter	integer	5
jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchAgentur	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchPromoter	integer	5
jobProfilAnzahlEinsaetzeGebucht	integer	5
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobProfilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobProfilProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "jobProfilJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilStatus": "Job-Profil wurde gebucht",
    "jobProfilAnzahlEinsaetze": 5,
    "jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden": 5,
    "jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter": 5,
    "jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchAgentur": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzeGebucht": 5,
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/profile/{profil_id}/jobprofile`

Abfrage von Job-Profilen zu einem Profil.

Abfrage von Job-Profilen zu einem Profil. Rückgabe der abgefragten Job-Profile eines Profils.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
profil_id	Pfad	string	ja	UUID eines Profils aus iPM_Promotion.
jobprofilstatus	Abfrage	string	nein	Filter nach dem Job-Profil-Status der Job-Profile. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/profile/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/jobprofile?jobprofilstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Job-Profile: Liste von Job-Profil.

Feld	Typ	Beispiel
jobProfilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobProfilProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
jobProfilJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilStatus	string	Job-Profil wurde gebucht
jobProfilAnzahlEinsaetze	integer	5
jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden	integer	5
jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter	integer	5
jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchAgentur	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchPromoter	integer	5
jobProfilAnzahlEinsaetzeGebucht	integer	5
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobProfilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobProfilProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "jobProfilJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilStatus": "Job-Profil wurde gebucht",
    "jobProfilAnzahlEinsaetze": 5,
    "jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden": 5,
    "jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter": 5,
    "jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchAgentur": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzeGebucht": 5,
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/projekte/{projekt_id}/jobprofile`

Abfrage von Job-Profilen zu einem Projekt.

Abfrage von Job-Profilen zu einem Projekt. Rückgabe der abgefragten Job-Profile eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
jobprofilstatus	Abfrage	string	nein	Filter nach dem Job-Profil-Status der Job-Profile. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/jobprofile?jobprofilstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Job-Profile: Liste von Job-Profil.

Feld	Typ	Beispiel
jobProfilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobProfilProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
jobProfilJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilStatus	string	Job-Profil wurde gebucht
jobProfilAnzahlEinsaetze	integer	5
jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden	integer	5
jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter	integer	5
jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchAgentur	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchPromoter	integer	5
jobProfilAnzahlEinsaetzeGebucht	integer	5
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobProfilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobProfilProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "jobProfilJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilStatus": "Job-Profil wurde gebucht",
    "jobProfilAnzahlEinsaetze": 5,
    "jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden": 5,
    "jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter": 5,
    "jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchAgentur": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzeGebucht": 5,
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/jobs/{job_id}/jobprofile`

Abfrage von Job-Profilen zu einem Job.

Abfrage von Job-Profilen zu einem Job. Rückgabe der abgefragten Job-Profile eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
jobprofilstatus	Abfrage	string	nein	Filter nach dem Job-Profil-Status der Job-Profile. Werte: `angefragt`, `beworben`, `zugesagt`, `gebucht`

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/jobprofile?jobprofilstatus=angefragt"

Antwort 200

Rückgabe eines/mehrerer Job-Profile: Liste von Job-Profil.

Feld	Typ	Beispiel
jobProfilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobProfilProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
jobProfilJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilStatus	string	Job-Profil wurde gebucht
jobProfilAnzahlEinsaetze	integer	5
jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden	integer	5
jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter	integer	5
jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchAgentur	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchPromoter	integer	5
jobProfilAnzahlEinsaetzeGebucht	integer	5
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "jobProfilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "jobProfilProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "jobProfilJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "jobProfilStatus": "Job-Profil wurde gebucht",
    "jobProfilAnzahlEinsaetze": 5,
    "jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden": 5,
    "jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter": 5,
    "jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchAgentur": 5,
    "jobProfilAnzahlEinsaetzAbgesagtDurchPromoter": 5,
    "jobProfilAnzahlEinsaetzeGebucht": 5,
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

10. Verfügbarkeiten

Verfügbarkeiten der Promoter je Datum, mit Notiz.

GET`/verfuegbarkeiten`

Abfrage von Verfügbarkeiten.

Abfrage von Verfügbarkeiten. Rückgabe der abgefragten Verfügbarkeiten.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
verfuegbar	Abfrage	string	nein	Filter nach der Verfügbarkeit (ja/nein).
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Verfügbarkeiten im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/verfuegbarkeiten?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Verfügbarkeiten: Liste von Verfügbarkeit.

Feld	Typ	Beispiel
verfuegbarkeitId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
verfuegbarkeitProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
verfuegbarkeitDatum	string	01.10.2018
verfuegbarkeitVerfuegbar	string	ja
verfuegbarkeitNotiz	string	Freitext der Notiz
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "verfuegbarkeitId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "verfuegbarkeitProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "verfuegbarkeitDatum": "01.10.2018",
    "verfuegbarkeitVerfuegbar": "ja",
    "verfuegbarkeitNotiz": "Freitext der Notiz",
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/profile/{profil_id}/verfuegbarkeiten`

Abfrage von Verfügbarkeiten zu einem Profil.

Abfrage von Verfügbarkeiten zu einem Profil. Rückgabe der abgefragten Verfügbarkeiten eines Profils.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
profil_id	Pfad	string	ja	UUID eines Profils aus iPM_Promotion.
verfuegbar	Abfrage	string	nein	Filter nach der Verfügbarkeit (ja/nein).
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Verfügbarkeiten im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/profile/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/verfuegbarkeiten?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Verfügbarkeiten: Liste von Verfügbarkeit.

Feld	Typ	Beispiel
verfuegbarkeitId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
verfuegbarkeitProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
verfuegbarkeitDatum	string	01.10.2018
verfuegbarkeitVerfuegbar	string	ja
verfuegbarkeitNotiz	string	Freitext der Notiz
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "verfuegbarkeitId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "verfuegbarkeitProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "verfuegbarkeitDatum": "01.10.2018",
    "verfuegbarkeitVerfuegbar": "ja",
    "verfuegbarkeitNotiz": "Freitext der Notiz",
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

11. Feedbacks

Feedbacks mit den Auswertungen der Fragebögen.

GET`/feedbacks/{feedback_id}`

Abfrage eines einzelnen Feedbacks.

Abfrage eines einzelnen Feedbacks. Rückgabe des abgefragten Feedbacks.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
feedback_id	Pfad	string	ja	UUID eines Feedbacks aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/feedbacks/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/frageboegen/{fragebogen_id}/feedbacks`

Abfrage von Feedbacks zu einem Fragebogen.

Abfrage von Feedbacks zu einem Fragebogen. Rückgabe der abgefragten Feedbacks eines Fragebogens.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
fragebogen_id	Pfad	string	ja	UUID eines Fragebogens aus iPM_Promotion.
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/frageboegen/<fragebogen-id>/feedbacks?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/projekte/{projekt_id}/frageboegen/{fragebogen_id}/feedbacks`

Abfrage von Feedbacks zu einem Projekt und einem Fragebogen.

Abfrage von Feedbacks zu einem Projekt und einem Fragebogen. Rückgabe der abgefragten Feedbacks eines Fragebogens innerhalb eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
fragebogen_id	Pfad	string	ja	UUID eines Fragebogens aus iPM_Promotion.
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/frageboegen/<fragebogen-id>/feedbacks?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/jobs/{job_id}/frageboegen/{fragebogen_id}/feedbacks`

Abfrage von Feedbacks zu einem Job und einem Fragebogen.

Abfrage von Feedbacks zu einem Job und einem Fragebogen. Rückgabe der abgefragten Feedbacks eines Fragebogens innerhalb eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
fragebogen_id	Pfad	string	ja	UUID eines Fragebogens aus iPM_Promotion.
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/frageboegen/<fragebogen-id>/feedbacks?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/kunden/{kunden_id}/frageboegen/{fragebogen_id}/feedbacks`

Abfrage von Feedbacks zu einem Kunden und einem Fragebogen.

Abfrage von Feedbacks zu einem Kunden und einem Fragebogen. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
fragebogen_id	Pfad	string	ja	UUID eines Fragebogens aus iPM_Promotion.
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/frageboegen/<fragebogen-id>/feedbacks?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/kunden/{kunden_id}/projekte/{projekt_id}/frageboegen/{fragebogen_id}/feedbacks`

Abfrage von Feedbacks zu einem Kunden, einem Projekt und einem Fragebogen.

Abfrage von Feedbacks zu einem Kunden, einem Projekt und einem Fragebogen. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
fragebogen_id	Pfad	string	ja	UUID eines Fragebogens aus iPM_Promotion.
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/frageboegen/<fragebogen-id>/feedbacks?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/kunden/{kunden_id}/jobs/{job_id}/frageboegen/{fragebogen_id}/feedbacks`

Abfrage von Feedbacks zu einem Kunden, einem Job und einem Fragebogen.

Abfrage von Feedbacks zu einem Kunden, einem Job und einem Fragebogen. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
fragebogen_id	Pfad	string	ja	UUID eines Fragebogens aus iPM_Promotion.
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Feedbacks im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/kunden/<kunden-id>/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/frageboegen/<fragebogen-id>/feedbacks?zeitraum=01.07.2017-31.07.2017"

Antwort 200

Rückgabe eines/mehrerer Feedbacks: Liste von Feedback.

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "feedbackId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "feedbackFragebogenId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "feedbackProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "feedbackJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "feedbackJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "feedbackTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "feedbackEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "feedbackAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "feedbackFragenAuswertungen": [
      {
        "key": "summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id",
        "value": "5"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

12. Einsatz-Abrechnungen

Abrechnungen der Einsätze mit Status, Beträgen für Einkauf und Verkauf und Positionen.

GET`/einsatzabrechnungen/{einsatzabrechnung_id}`

Abfrage einer einzelnen Einsatz-Abrechnung.

Abfrage einer einzelnen Einsatz-Abrechnung. Rückgabe der abgefragten Einsatz-Abrechnung.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
einsatzabrechnung_id	Pfad	string	ja	UUID einer Einsatz-Abrechnung aus iPM_Promotion.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/einsatzabrechnungen/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958"

Antwort 200

Rückgabe einer/mehrerer Einsatz-Abrechnungen: Liste von Einsatz-Abrechnung.

Feld	Typ	Beispiel
einsatzAbrechnungId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
einsatzAbrechnungProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzAbrechnungJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
einsatzAbrechnungJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
einsatzAbrechnungTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzAbrechnungEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
einsatzAbrechnungAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
einsatzAbrechnungAbrechnungsstatus	string	Abrechnung abgeschlossen
einsatzAbrechnungWaehrung	string	EUR
einsatzAbrechnungEinkaufNettoGesamt	string	100,00
einsatzAbrechnungEinkaufUStGesamt	string	19,00
einsatzAbrechnungEinkaufBruttoGesamt	string	119,00
einsatzAbrechnungVerkaufNettoGesamt	string	100,00
einsatzAbrechnungVerkaufUStGesamt	string	19,00
einsatzAbrechnungVerkaufBruttoGesamt	string	119,00
einsatzAbrechnungEinkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungEinkaufUStGrundverguetung	string	19,00
einsatzAbrechnungEinkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungVerkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungVerkaufUStGrundverguetung	string	19,00
einsatzAbrechnungVerkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungEinkaufNettoPraemien	string	100,00
einsatzAbrechnungEinkaufUStPraemien	string	19,00
einsatzAbrechnungEinkaufBruttoPraemien	string	119,00
einsatzAbrechnungVerkaufNettoPraemien	string	100,00
einsatzAbrechnungVerkaufUStPraemien	string	19,00
einsatzAbrechnungVerkaufBruttoPraemien	string	119,00
einsatzAbrechnungEinkaufNettoProvisionen	string	100,00
einsatzAbrechnungEinkaufUStProvisionen	string	19,00
einsatzAbrechnungEinkaufBruttoProvisionen	string	119,00
einsatzAbrechnungVerkaufNettoProvisionen	string	100,00
einsatzAbrechnungVerkaufUStProvisionen	string	19,00
einsatzAbrechnungVerkaufBruttoProvisionen	string	119,00
einsatzAbrechnungEinkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungEinkaufUStFahrtkosten	string	19,00
einsatzAbrechnungEinkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungVerkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungVerkaufUStFahrtkosten	string	19,00
einsatzAbrechnungVerkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungEinkaufNettoAuslagen	string	100,00
einsatzAbrechnungEinkaufUStAuslagen	string	19,00
einsatzAbrechnungEinkaufBruttoAuslagen	string	119,00
einsatzAbrechnungVerkaufNettoAuslagen	string	100,00
einsatzAbrechnungVerkaufUStAuslagen	string	19,00
einsatzAbrechnungVerkaufBruttoAuslagen	string	119,00
einsatzAbrechnungEinkaufNettoSonstiges	string	100,00
einsatzAbrechnungEinkaufUStSonstiges	string	19,00
einsatzAbrechnungEinkaufBruttoSonstiges	string	119,00
einsatzAbrechnungVerkaufNettoSonstiges	string	100,00
einsatzAbrechnungVerkaufUStSonstiges	string	19,00
einsatzAbrechnungVerkaufBruttoSonstiges	string	119,00
einsatzAbrechnungPositionen	Liste von Einsatz-Abrechnung-Position	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
einsatz	Einsatz	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzAbrechnungId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzAbrechnungProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "einsatzAbrechnungProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzAbrechnungJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "einsatzAbrechnungJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "einsatzAbrechnungTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzAbrechnungEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "einsatzAbrechnungAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "einsatzAbrechnungAbrechnungsstatus": "Abrechnung abgeschlossen",
    "einsatzAbrechnungWaehrung": "EUR",
    "einsatzAbrechnungEinkaufNettoGesamt": "100,00",
    "einsatzAbrechnungEinkaufUStGesamt": "19,00",
    "einsatzAbrechnungEinkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungVerkaufNettoGesamt": "100,00",
    "einsatzAbrechnungVerkaufUStGesamt": "19,00",
    "einsatzAbrechnungVerkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungEinkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungEinkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungEinkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungVerkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungVerkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungVerkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungEinkaufNettoPraemien": "100,00",
    "einsatzAbrechnungEinkaufUStPraemien": "19,00",
    "einsatzAbrechnungEinkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungVerkaufNettoPraemien": "100,00",
    "einsatzAbrechnungVerkaufUStPraemien": "19,00",
    "einsatzAbrechnungVerkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungEinkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungEinkaufUStProvisionen": "19,00",
    "einsatzAbrechnungEinkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungVerkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungVerkaufUStProvisionen": "19,00",
    "einsatzAbrechnungVerkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungEinkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungEinkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungEinkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungVerkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungVerkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungVerkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungEinkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungEinkaufUStAuslagen": "19,00",
    "einsatzAbrechnungEinkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungVerkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungVerkaufUStAuslagen": "19,00",
    "einsatzAbrechnungVerkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungEinkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungEinkaufUStSonstiges": "19,00",
    "einsatzAbrechnungEinkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungVerkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungVerkaufUStSonstiges": "19,00",
    "einsatzAbrechnungVerkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungPositionen": [
      {
        "einsatzAbrechnungsPositionId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
        "einsatzAbrechnungsPositionTitel": "Tagessatz",
        "einsatzAbrechnungsPositionBeschreibung": "Freitext/Beschreibung vom Promoter",
        "einsatzAbrechnungsPositionBerechnungstyp": "Netto-Plan-Arbeitszeit pro Stunde",
        "einsatzAbrechnungsPositionKosteneinordnung": "Grundvergütung",
        "einsatzAbrechnungsPositionBerechnungInPlankosten": "Nein",
        "einsatzAbrechnungsPositionBerechnungInIstkosten": "Ja",
        "einsatzAbrechnungsPositionErloeskonto": "8400",
        "einsatzAbrechnungsPositionAufwandskonto": "1740",
        "einsatzAbrechnungsPositionKostenstelle": "1700",
        "einsatzAbrechnungsPositionKostentraeger": "1700",
        "einsatzAbrechnungsPositionLohnart": "11",
        "einsatzAbrechnungsPositionBearbeitungsschluessel": "3",
        "einsatzAbrechnungsPositionEinkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionEinkaufPreis": "10,00",
        "einsatzAbrechnungsPositionEinkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionEinkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionEinkaufNetto": "85,00",
        "einsatzAbrechnungsPositionEinkaufUSt": "16,15",
        "einsatzAbrechnungsPositionEinkaufBrutto": "101,15",
        "einsatzAbrechnungsPositionVerkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionVerkaufPreis": "20,00",
        "einsatzAbrechnungsPositionVerkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionVerkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionVerkaufNetto": "170,00",
        "einsatzAbrechnungsPositionVerkaufUSt": "32,30",
        "einsatzAbrechnungsPositionVerkaufBrutto": "202,30"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/einsatzabrechnungen`

Abfrage von Einsatz-Abrechnungen.

Abfrage von Einsatz-Abrechnungen. Rückgabe der abgefragten Einsatz-Abrechnungen.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
abrechnungsstatus	Abfrage	string	nein	Filter nach dem Abrechnungsstatus der Einsatz-Abrechnungen. Werte: `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`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsatz-Abrechnungen im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/einsatzabrechnungen?abrechnungsstatus=vorbereitet_durch_agentur"

Antwort 200

Rückgabe einer/mehrerer Einsatz-Abrechnungen: Liste von Einsatz-Abrechnung.

Feld	Typ	Beispiel
einsatzAbrechnungId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
einsatzAbrechnungProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzAbrechnungJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
einsatzAbrechnungJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
einsatzAbrechnungTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzAbrechnungEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
einsatzAbrechnungAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
einsatzAbrechnungAbrechnungsstatus	string	Abrechnung abgeschlossen
einsatzAbrechnungWaehrung	string	EUR
einsatzAbrechnungEinkaufNettoGesamt	string	100,00
einsatzAbrechnungEinkaufUStGesamt	string	19,00
einsatzAbrechnungEinkaufBruttoGesamt	string	119,00
einsatzAbrechnungVerkaufNettoGesamt	string	100,00
einsatzAbrechnungVerkaufUStGesamt	string	19,00
einsatzAbrechnungVerkaufBruttoGesamt	string	119,00
einsatzAbrechnungEinkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungEinkaufUStGrundverguetung	string	19,00
einsatzAbrechnungEinkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungVerkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungVerkaufUStGrundverguetung	string	19,00
einsatzAbrechnungVerkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungEinkaufNettoPraemien	string	100,00
einsatzAbrechnungEinkaufUStPraemien	string	19,00
einsatzAbrechnungEinkaufBruttoPraemien	string	119,00
einsatzAbrechnungVerkaufNettoPraemien	string	100,00
einsatzAbrechnungVerkaufUStPraemien	string	19,00
einsatzAbrechnungVerkaufBruttoPraemien	string	119,00
einsatzAbrechnungEinkaufNettoProvisionen	string	100,00
einsatzAbrechnungEinkaufUStProvisionen	string	19,00
einsatzAbrechnungEinkaufBruttoProvisionen	string	119,00
einsatzAbrechnungVerkaufNettoProvisionen	string	100,00
einsatzAbrechnungVerkaufUStProvisionen	string	19,00
einsatzAbrechnungVerkaufBruttoProvisionen	string	119,00
einsatzAbrechnungEinkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungEinkaufUStFahrtkosten	string	19,00
einsatzAbrechnungEinkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungVerkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungVerkaufUStFahrtkosten	string	19,00
einsatzAbrechnungVerkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungEinkaufNettoAuslagen	string	100,00
einsatzAbrechnungEinkaufUStAuslagen	string	19,00
einsatzAbrechnungEinkaufBruttoAuslagen	string	119,00
einsatzAbrechnungVerkaufNettoAuslagen	string	100,00
einsatzAbrechnungVerkaufUStAuslagen	string	19,00
einsatzAbrechnungVerkaufBruttoAuslagen	string	119,00
einsatzAbrechnungEinkaufNettoSonstiges	string	100,00
einsatzAbrechnungEinkaufUStSonstiges	string	19,00
einsatzAbrechnungEinkaufBruttoSonstiges	string	119,00
einsatzAbrechnungVerkaufNettoSonstiges	string	100,00
einsatzAbrechnungVerkaufUStSonstiges	string	19,00
einsatzAbrechnungVerkaufBruttoSonstiges	string	119,00
einsatzAbrechnungPositionen	Liste von Einsatz-Abrechnung-Position	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
einsatz	Einsatz	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzAbrechnungId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzAbrechnungProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "einsatzAbrechnungProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzAbrechnungJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "einsatzAbrechnungJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "einsatzAbrechnungTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzAbrechnungEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "einsatzAbrechnungAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "einsatzAbrechnungAbrechnungsstatus": "Abrechnung abgeschlossen",
    "einsatzAbrechnungWaehrung": "EUR",
    "einsatzAbrechnungEinkaufNettoGesamt": "100,00",
    "einsatzAbrechnungEinkaufUStGesamt": "19,00",
    "einsatzAbrechnungEinkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungVerkaufNettoGesamt": "100,00",
    "einsatzAbrechnungVerkaufUStGesamt": "19,00",
    "einsatzAbrechnungVerkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungEinkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungEinkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungEinkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungVerkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungVerkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungVerkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungEinkaufNettoPraemien": "100,00",
    "einsatzAbrechnungEinkaufUStPraemien": "19,00",
    "einsatzAbrechnungEinkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungVerkaufNettoPraemien": "100,00",
    "einsatzAbrechnungVerkaufUStPraemien": "19,00",
    "einsatzAbrechnungVerkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungEinkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungEinkaufUStProvisionen": "19,00",
    "einsatzAbrechnungEinkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungVerkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungVerkaufUStProvisionen": "19,00",
    "einsatzAbrechnungVerkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungEinkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungEinkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungEinkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungVerkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungVerkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungVerkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungEinkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungEinkaufUStAuslagen": "19,00",
    "einsatzAbrechnungEinkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungVerkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungVerkaufUStAuslagen": "19,00",
    "einsatzAbrechnungVerkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungEinkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungEinkaufUStSonstiges": "19,00",
    "einsatzAbrechnungEinkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungVerkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungVerkaufUStSonstiges": "19,00",
    "einsatzAbrechnungVerkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungPositionen": [
      {
        "einsatzAbrechnungsPositionId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
        "einsatzAbrechnungsPositionTitel": "Tagessatz",
        "einsatzAbrechnungsPositionBeschreibung": "Freitext/Beschreibung vom Promoter",
        "einsatzAbrechnungsPositionBerechnungstyp": "Netto-Plan-Arbeitszeit pro Stunde",
        "einsatzAbrechnungsPositionKosteneinordnung": "Grundvergütung",
        "einsatzAbrechnungsPositionBerechnungInPlankosten": "Nein",
        "einsatzAbrechnungsPositionBerechnungInIstkosten": "Ja",
        "einsatzAbrechnungsPositionErloeskonto": "8400",
        "einsatzAbrechnungsPositionAufwandskonto": "1740",
        "einsatzAbrechnungsPositionKostenstelle": "1700",
        "einsatzAbrechnungsPositionKostentraeger": "1700",
        "einsatzAbrechnungsPositionLohnart": "11",
        "einsatzAbrechnungsPositionBearbeitungsschluessel": "3",
        "einsatzAbrechnungsPositionEinkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionEinkaufPreis": "10,00",
        "einsatzAbrechnungsPositionEinkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionEinkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionEinkaufNetto": "85,00",
        "einsatzAbrechnungsPositionEinkaufUSt": "16,15",
        "einsatzAbrechnungsPositionEinkaufBrutto": "101,15",
        "einsatzAbrechnungsPositionVerkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionVerkaufPreis": "20,00",
        "einsatzAbrechnungsPositionVerkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionVerkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionVerkaufNetto": "170,00",
        "einsatzAbrechnungsPositionVerkaufUSt": "32,30",
        "einsatzAbrechnungsPositionVerkaufBrutto": "202,30"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/projekte/{projekt_id}/einsatzabrechnungen`

Abfrage von Einsatz-Abrechnungen zu einem Projekt.

Abfrage von Einsatz-Abrechnungen zu einem Projekt. Rückgabe der abgefragten Einsatz-Abrechnungen eines Projekt.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
abrechnungsstatus	Abfrage	string	nein	Filter nach dem Abrechnungsstatus der Einsatz-Abrechnungen. Werte: `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`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsatz-Abrechnungen im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsatzabrechnungen?abrechnungsstatus=vorbereitet_durch_agentur"

Antwort 200

Rückgabe einer/mehrerer Einsatz-Abrechnungen: Liste von Einsatz-Abrechnung.

Feld	Typ	Beispiel
einsatzAbrechnungId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
einsatzAbrechnungProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzAbrechnungJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
einsatzAbrechnungJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
einsatzAbrechnungTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzAbrechnungEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
einsatzAbrechnungAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
einsatzAbrechnungAbrechnungsstatus	string	Abrechnung abgeschlossen
einsatzAbrechnungWaehrung	string	EUR
einsatzAbrechnungEinkaufNettoGesamt	string	100,00
einsatzAbrechnungEinkaufUStGesamt	string	19,00
einsatzAbrechnungEinkaufBruttoGesamt	string	119,00
einsatzAbrechnungVerkaufNettoGesamt	string	100,00
einsatzAbrechnungVerkaufUStGesamt	string	19,00
einsatzAbrechnungVerkaufBruttoGesamt	string	119,00
einsatzAbrechnungEinkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungEinkaufUStGrundverguetung	string	19,00
einsatzAbrechnungEinkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungVerkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungVerkaufUStGrundverguetung	string	19,00
einsatzAbrechnungVerkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungEinkaufNettoPraemien	string	100,00
einsatzAbrechnungEinkaufUStPraemien	string	19,00
einsatzAbrechnungEinkaufBruttoPraemien	string	119,00
einsatzAbrechnungVerkaufNettoPraemien	string	100,00
einsatzAbrechnungVerkaufUStPraemien	string	19,00
einsatzAbrechnungVerkaufBruttoPraemien	string	119,00
einsatzAbrechnungEinkaufNettoProvisionen	string	100,00
einsatzAbrechnungEinkaufUStProvisionen	string	19,00
einsatzAbrechnungEinkaufBruttoProvisionen	string	119,00
einsatzAbrechnungVerkaufNettoProvisionen	string	100,00
einsatzAbrechnungVerkaufUStProvisionen	string	19,00
einsatzAbrechnungVerkaufBruttoProvisionen	string	119,00
einsatzAbrechnungEinkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungEinkaufUStFahrtkosten	string	19,00
einsatzAbrechnungEinkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungVerkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungVerkaufUStFahrtkosten	string	19,00
einsatzAbrechnungVerkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungEinkaufNettoAuslagen	string	100,00
einsatzAbrechnungEinkaufUStAuslagen	string	19,00
einsatzAbrechnungEinkaufBruttoAuslagen	string	119,00
einsatzAbrechnungVerkaufNettoAuslagen	string	100,00
einsatzAbrechnungVerkaufUStAuslagen	string	19,00
einsatzAbrechnungVerkaufBruttoAuslagen	string	119,00
einsatzAbrechnungEinkaufNettoSonstiges	string	100,00
einsatzAbrechnungEinkaufUStSonstiges	string	19,00
einsatzAbrechnungEinkaufBruttoSonstiges	string	119,00
einsatzAbrechnungVerkaufNettoSonstiges	string	100,00
einsatzAbrechnungVerkaufUStSonstiges	string	19,00
einsatzAbrechnungVerkaufBruttoSonstiges	string	119,00
einsatzAbrechnungPositionen	Liste von Einsatz-Abrechnung-Position	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
einsatz	Einsatz	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzAbrechnungId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzAbrechnungProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "einsatzAbrechnungProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzAbrechnungJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "einsatzAbrechnungJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "einsatzAbrechnungTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzAbrechnungEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "einsatzAbrechnungAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "einsatzAbrechnungAbrechnungsstatus": "Abrechnung abgeschlossen",
    "einsatzAbrechnungWaehrung": "EUR",
    "einsatzAbrechnungEinkaufNettoGesamt": "100,00",
    "einsatzAbrechnungEinkaufUStGesamt": "19,00",
    "einsatzAbrechnungEinkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungVerkaufNettoGesamt": "100,00",
    "einsatzAbrechnungVerkaufUStGesamt": "19,00",
    "einsatzAbrechnungVerkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungEinkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungEinkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungEinkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungVerkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungVerkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungVerkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungEinkaufNettoPraemien": "100,00",
    "einsatzAbrechnungEinkaufUStPraemien": "19,00",
    "einsatzAbrechnungEinkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungVerkaufNettoPraemien": "100,00",
    "einsatzAbrechnungVerkaufUStPraemien": "19,00",
    "einsatzAbrechnungVerkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungEinkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungEinkaufUStProvisionen": "19,00",
    "einsatzAbrechnungEinkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungVerkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungVerkaufUStProvisionen": "19,00",
    "einsatzAbrechnungVerkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungEinkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungEinkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungEinkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungVerkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungVerkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungVerkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungEinkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungEinkaufUStAuslagen": "19,00",
    "einsatzAbrechnungEinkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungVerkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungVerkaufUStAuslagen": "19,00",
    "einsatzAbrechnungVerkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungEinkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungEinkaufUStSonstiges": "19,00",
    "einsatzAbrechnungEinkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungVerkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungVerkaufUStSonstiges": "19,00",
    "einsatzAbrechnungVerkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungPositionen": [
      {
        "einsatzAbrechnungsPositionId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
        "einsatzAbrechnungsPositionTitel": "Tagessatz",
        "einsatzAbrechnungsPositionBeschreibung": "Freitext/Beschreibung vom Promoter",
        "einsatzAbrechnungsPositionBerechnungstyp": "Netto-Plan-Arbeitszeit pro Stunde",
        "einsatzAbrechnungsPositionKosteneinordnung": "Grundvergütung",
        "einsatzAbrechnungsPositionBerechnungInPlankosten": "Nein",
        "einsatzAbrechnungsPositionBerechnungInIstkosten": "Ja",
        "einsatzAbrechnungsPositionErloeskonto": "8400",
        "einsatzAbrechnungsPositionAufwandskonto": "1740",
        "einsatzAbrechnungsPositionKostenstelle": "1700",
        "einsatzAbrechnungsPositionKostentraeger": "1700",
        "einsatzAbrechnungsPositionLohnart": "11",
        "einsatzAbrechnungsPositionBearbeitungsschluessel": "3",
        "einsatzAbrechnungsPositionEinkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionEinkaufPreis": "10,00",
        "einsatzAbrechnungsPositionEinkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionEinkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionEinkaufNetto": "85,00",
        "einsatzAbrechnungsPositionEinkaufUSt": "16,15",
        "einsatzAbrechnungsPositionEinkaufBrutto": "101,15",
        "einsatzAbrechnungsPositionVerkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionVerkaufPreis": "20,00",
        "einsatzAbrechnungsPositionVerkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionVerkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionVerkaufNetto": "170,00",
        "einsatzAbrechnungsPositionVerkaufUSt": "32,30",
        "einsatzAbrechnungsPositionVerkaufBrutto": "202,30"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/jobs/{job_id}/einsatzabrechnungen`

Abfrage von Einsatz-Abrechnungen zu einem Job.

Abfrage von Einsatz-Abrechnungen zu einem Job. Rückgabe der abgefragten Einsatz-Abrechnungen eines Jobs.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
abrechnungsstatus	Abfrage	string	nein	Filter nach dem Abrechnungsstatus der Einsatz-Abrechnungen. Werte: `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`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsatz-Abrechnungen im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsatzabrechnungen?abrechnungsstatus=vorbereitet_durch_agentur"

Antwort 200

Rückgabe einer/mehrerer Einsatz-Abrechnungen: Liste von Einsatz-Abrechnung.

Feld	Typ	Beispiel
einsatzAbrechnungId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
einsatzAbrechnungProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzAbrechnungJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
einsatzAbrechnungJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
einsatzAbrechnungTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzAbrechnungEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
einsatzAbrechnungAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
einsatzAbrechnungAbrechnungsstatus	string	Abrechnung abgeschlossen
einsatzAbrechnungWaehrung	string	EUR
einsatzAbrechnungEinkaufNettoGesamt	string	100,00
einsatzAbrechnungEinkaufUStGesamt	string	19,00
einsatzAbrechnungEinkaufBruttoGesamt	string	119,00
einsatzAbrechnungVerkaufNettoGesamt	string	100,00
einsatzAbrechnungVerkaufUStGesamt	string	19,00
einsatzAbrechnungVerkaufBruttoGesamt	string	119,00
einsatzAbrechnungEinkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungEinkaufUStGrundverguetung	string	19,00
einsatzAbrechnungEinkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungVerkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungVerkaufUStGrundverguetung	string	19,00
einsatzAbrechnungVerkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungEinkaufNettoPraemien	string	100,00
einsatzAbrechnungEinkaufUStPraemien	string	19,00
einsatzAbrechnungEinkaufBruttoPraemien	string	119,00
einsatzAbrechnungVerkaufNettoPraemien	string	100,00
einsatzAbrechnungVerkaufUStPraemien	string	19,00
einsatzAbrechnungVerkaufBruttoPraemien	string	119,00
einsatzAbrechnungEinkaufNettoProvisionen	string	100,00
einsatzAbrechnungEinkaufUStProvisionen	string	19,00
einsatzAbrechnungEinkaufBruttoProvisionen	string	119,00
einsatzAbrechnungVerkaufNettoProvisionen	string	100,00
einsatzAbrechnungVerkaufUStProvisionen	string	19,00
einsatzAbrechnungVerkaufBruttoProvisionen	string	119,00
einsatzAbrechnungEinkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungEinkaufUStFahrtkosten	string	19,00
einsatzAbrechnungEinkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungVerkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungVerkaufUStFahrtkosten	string	19,00
einsatzAbrechnungVerkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungEinkaufNettoAuslagen	string	100,00
einsatzAbrechnungEinkaufUStAuslagen	string	19,00
einsatzAbrechnungEinkaufBruttoAuslagen	string	119,00
einsatzAbrechnungVerkaufNettoAuslagen	string	100,00
einsatzAbrechnungVerkaufUStAuslagen	string	19,00
einsatzAbrechnungVerkaufBruttoAuslagen	string	119,00
einsatzAbrechnungEinkaufNettoSonstiges	string	100,00
einsatzAbrechnungEinkaufUStSonstiges	string	19,00
einsatzAbrechnungEinkaufBruttoSonstiges	string	119,00
einsatzAbrechnungVerkaufNettoSonstiges	string	100,00
einsatzAbrechnungVerkaufUStSonstiges	string	19,00
einsatzAbrechnungVerkaufBruttoSonstiges	string	119,00
einsatzAbrechnungPositionen	Liste von Einsatz-Abrechnung-Position	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
einsatz	Einsatz	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzAbrechnungId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzAbrechnungProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "einsatzAbrechnungProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzAbrechnungJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "einsatzAbrechnungJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "einsatzAbrechnungTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzAbrechnungEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "einsatzAbrechnungAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "einsatzAbrechnungAbrechnungsstatus": "Abrechnung abgeschlossen",
    "einsatzAbrechnungWaehrung": "EUR",
    "einsatzAbrechnungEinkaufNettoGesamt": "100,00",
    "einsatzAbrechnungEinkaufUStGesamt": "19,00",
    "einsatzAbrechnungEinkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungVerkaufNettoGesamt": "100,00",
    "einsatzAbrechnungVerkaufUStGesamt": "19,00",
    "einsatzAbrechnungVerkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungEinkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungEinkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungEinkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungVerkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungVerkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungVerkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungEinkaufNettoPraemien": "100,00",
    "einsatzAbrechnungEinkaufUStPraemien": "19,00",
    "einsatzAbrechnungEinkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungVerkaufNettoPraemien": "100,00",
    "einsatzAbrechnungVerkaufUStPraemien": "19,00",
    "einsatzAbrechnungVerkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungEinkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungEinkaufUStProvisionen": "19,00",
    "einsatzAbrechnungEinkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungVerkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungVerkaufUStProvisionen": "19,00",
    "einsatzAbrechnungVerkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungEinkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungEinkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungEinkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungVerkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungVerkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungVerkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungEinkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungEinkaufUStAuslagen": "19,00",
    "einsatzAbrechnungEinkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungVerkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungVerkaufUStAuslagen": "19,00",
    "einsatzAbrechnungVerkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungEinkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungEinkaufUStSonstiges": "19,00",
    "einsatzAbrechnungEinkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungVerkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungVerkaufUStSonstiges": "19,00",
    "einsatzAbrechnungVerkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungPositionen": [
      {
        "einsatzAbrechnungsPositionId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
        "einsatzAbrechnungsPositionTitel": "Tagessatz",
        "einsatzAbrechnungsPositionBeschreibung": "Freitext/Beschreibung vom Promoter",
        "einsatzAbrechnungsPositionBerechnungstyp": "Netto-Plan-Arbeitszeit pro Stunde",
        "einsatzAbrechnungsPositionKosteneinordnung": "Grundvergütung",
        "einsatzAbrechnungsPositionBerechnungInPlankosten": "Nein",
        "einsatzAbrechnungsPositionBerechnungInIstkosten": "Ja",
        "einsatzAbrechnungsPositionErloeskonto": "8400",
        "einsatzAbrechnungsPositionAufwandskonto": "1740",
        "einsatzAbrechnungsPositionKostenstelle": "1700",
        "einsatzAbrechnungsPositionKostentraeger": "1700",
        "einsatzAbrechnungsPositionLohnart": "11",
        "einsatzAbrechnungsPositionBearbeitungsschluessel": "3",
        "einsatzAbrechnungsPositionEinkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionEinkaufPreis": "10,00",
        "einsatzAbrechnungsPositionEinkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionEinkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionEinkaufNetto": "85,00",
        "einsatzAbrechnungsPositionEinkaufUSt": "16,15",
        "einsatzAbrechnungsPositionEinkaufBrutto": "101,15",
        "einsatzAbrechnungsPositionVerkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionVerkaufPreis": "20,00",
        "einsatzAbrechnungsPositionVerkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionVerkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionVerkaufNetto": "170,00",
        "einsatzAbrechnungsPositionVerkaufUSt": "32,30",
        "einsatzAbrechnungsPositionVerkaufBrutto": "202,30"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/profile/{profil_id}/einsatzabrechnungen`

Abfrage von Einsatz-Abrechnungen zu einem Profil.

Abfrage von Einsatz-Abrechnungen zu einem Profil. Rückgabe der abgefragten Einsatz-Abrechnungen eines Profils.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
profil_id	Pfad	string	ja	UUID eines Profils aus iPM_Promotion.
abrechnungsstatus	Abfrage	string	nein	Filter nach dem Abrechnungsstatus der Einsatz-Abrechnungen. Werte: `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`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Einsatz-Abrechnungen im Format dd.mm.yyyy-dd.mm.yyyy.

Beispielaufruf

curl -H "api-key: <api-key>" \
  "https://ihre-domain.de/api/1/profile/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/einsatzabrechnungen?abrechnungsstatus=vorbereitet_durch_agentur"

Antwort 200

Rückgabe einer/mehrerer Einsatz-Abrechnungen: Liste von Einsatz-Abrechnung.

Feld	Typ	Beispiel
einsatzAbrechnungId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
einsatzAbrechnungProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzAbrechnungJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
einsatzAbrechnungJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
einsatzAbrechnungTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzAbrechnungEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
einsatzAbrechnungAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
einsatzAbrechnungAbrechnungsstatus	string	Abrechnung abgeschlossen
einsatzAbrechnungWaehrung	string	EUR
einsatzAbrechnungEinkaufNettoGesamt	string	100,00
einsatzAbrechnungEinkaufUStGesamt	string	19,00
einsatzAbrechnungEinkaufBruttoGesamt	string	119,00
einsatzAbrechnungVerkaufNettoGesamt	string	100,00
einsatzAbrechnungVerkaufUStGesamt	string	19,00
einsatzAbrechnungVerkaufBruttoGesamt	string	119,00
einsatzAbrechnungEinkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungEinkaufUStGrundverguetung	string	19,00
einsatzAbrechnungEinkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungVerkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungVerkaufUStGrundverguetung	string	19,00
einsatzAbrechnungVerkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungEinkaufNettoPraemien	string	100,00
einsatzAbrechnungEinkaufUStPraemien	string	19,00
einsatzAbrechnungEinkaufBruttoPraemien	string	119,00
einsatzAbrechnungVerkaufNettoPraemien	string	100,00
einsatzAbrechnungVerkaufUStPraemien	string	19,00
einsatzAbrechnungVerkaufBruttoPraemien	string	119,00
einsatzAbrechnungEinkaufNettoProvisionen	string	100,00
einsatzAbrechnungEinkaufUStProvisionen	string	19,00
einsatzAbrechnungEinkaufBruttoProvisionen	string	119,00
einsatzAbrechnungVerkaufNettoProvisionen	string	100,00
einsatzAbrechnungVerkaufUStProvisionen	string	19,00
einsatzAbrechnungVerkaufBruttoProvisionen	string	119,00
einsatzAbrechnungEinkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungEinkaufUStFahrtkosten	string	19,00
einsatzAbrechnungEinkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungVerkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungVerkaufUStFahrtkosten	string	19,00
einsatzAbrechnungVerkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungEinkaufNettoAuslagen	string	100,00
einsatzAbrechnungEinkaufUStAuslagen	string	19,00
einsatzAbrechnungEinkaufBruttoAuslagen	string	119,00
einsatzAbrechnungVerkaufNettoAuslagen	string	100,00
einsatzAbrechnungVerkaufUStAuslagen	string	19,00
einsatzAbrechnungVerkaufBruttoAuslagen	string	119,00
einsatzAbrechnungEinkaufNettoSonstiges	string	100,00
einsatzAbrechnungEinkaufUStSonstiges	string	19,00
einsatzAbrechnungEinkaufBruttoSonstiges	string	119,00
einsatzAbrechnungVerkaufNettoSonstiges	string	100,00
einsatzAbrechnungVerkaufUStSonstiges	string	19,00
einsatzAbrechnungVerkaufBruttoSonstiges	string	119,00
einsatzAbrechnungPositionen	Liste von Einsatz-Abrechnung-Position	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
einsatz	Einsatz	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Beispielantwort 200 (verschachtelte Strukturen eine Ebene tief)

[
  {
    "einsatzAbrechnungId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
    "einsatzAbrechnungProfilId": "d5669b28-7600-4a8a-a803-8414cb268bc6",
    "einsatzAbrechnungProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
    "einsatzAbrechnungJobId": "fcfc8425-e27a-414d-8a4d-8814330d0230",
    "einsatzAbrechnungJobProfilId": "782839e3-5dee-41a8-8352-6b0c0d644a96",
    "einsatzAbrechnungTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
    "einsatzAbrechnungEinsatzId": "d26d92ba-3b22-4d63-b0ef-da2f3921a000",
    "einsatzAbrechnungAktionsstandortId": "483774df-3ec0-469f-8449-98207243237f",
    "einsatzAbrechnungAbrechnungsstatus": "Abrechnung abgeschlossen",
    "einsatzAbrechnungWaehrung": "EUR",
    "einsatzAbrechnungEinkaufNettoGesamt": "100,00",
    "einsatzAbrechnungEinkaufUStGesamt": "19,00",
    "einsatzAbrechnungEinkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungVerkaufNettoGesamt": "100,00",
    "einsatzAbrechnungVerkaufUStGesamt": "19,00",
    "einsatzAbrechnungVerkaufBruttoGesamt": "119,00",
    "einsatzAbrechnungEinkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungEinkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungEinkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungVerkaufNettoGrundverguetung": "100,00",
    "einsatzAbrechnungVerkaufUStGrundverguetung": "19,00",
    "einsatzAbrechnungVerkaufBruttoGrundverguetung": "119,00",
    "einsatzAbrechnungEinkaufNettoPraemien": "100,00",
    "einsatzAbrechnungEinkaufUStPraemien": "19,00",
    "einsatzAbrechnungEinkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungVerkaufNettoPraemien": "100,00",
    "einsatzAbrechnungVerkaufUStPraemien": "19,00",
    "einsatzAbrechnungVerkaufBruttoPraemien": "119,00",
    "einsatzAbrechnungEinkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungEinkaufUStProvisionen": "19,00",
    "einsatzAbrechnungEinkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungVerkaufNettoProvisionen": "100,00",
    "einsatzAbrechnungVerkaufUStProvisionen": "19,00",
    "einsatzAbrechnungVerkaufBruttoProvisionen": "119,00",
    "einsatzAbrechnungEinkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungEinkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungEinkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungVerkaufNettoFahrtkosten": "100,00",
    "einsatzAbrechnungVerkaufUStFahrtkosten": "19,00",
    "einsatzAbrechnungVerkaufBruttoFahrtkosten": "119,00",
    "einsatzAbrechnungEinkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungEinkaufUStAuslagen": "19,00",
    "einsatzAbrechnungEinkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungVerkaufNettoAuslagen": "100,00",
    "einsatzAbrechnungVerkaufUStAuslagen": "19,00",
    "einsatzAbrechnungVerkaufBruttoAuslagen": "119,00",
    "einsatzAbrechnungEinkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungEinkaufUStSonstiges": "19,00",
    "einsatzAbrechnungEinkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungVerkaufNettoSonstiges": "100,00",
    "einsatzAbrechnungVerkaufUStSonstiges": "19,00",
    "einsatzAbrechnungVerkaufBruttoSonstiges": "119,00",
    "einsatzAbrechnungPositionen": [
      {
        "einsatzAbrechnungsPositionId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
        "einsatzAbrechnungsPositionTitel": "Tagessatz",
        "einsatzAbrechnungsPositionBeschreibung": "Freitext/Beschreibung vom Promoter",
        "einsatzAbrechnungsPositionBerechnungstyp": "Netto-Plan-Arbeitszeit pro Stunde",
        "einsatzAbrechnungsPositionKosteneinordnung": "Grundvergütung",
        "einsatzAbrechnungsPositionBerechnungInPlankosten": "Nein",
        "einsatzAbrechnungsPositionBerechnungInIstkosten": "Ja",
        "einsatzAbrechnungsPositionErloeskonto": "8400",
        "einsatzAbrechnungsPositionAufwandskonto": "1740",
        "einsatzAbrechnungsPositionKostenstelle": "1700",
        "einsatzAbrechnungsPositionKostentraeger": "1700",
        "einsatzAbrechnungsPositionLohnart": "11",
        "einsatzAbrechnungsPositionBearbeitungsschluessel": "3",
        "einsatzAbrechnungsPositionEinkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionEinkaufPreis": "10,00",
        "einsatzAbrechnungsPositionEinkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionEinkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionEinkaufNetto": "85,00",
        "einsatzAbrechnungsPositionEinkaufUSt": "16,15",
        "einsatzAbrechnungsPositionEinkaufBrutto": "101,15",
        "einsatzAbrechnungsPositionVerkaufAnzahl": "8,50",
        "einsatzAbrechnungsPositionVerkaufPreis": "20,00",
        "einsatzAbrechnungsPositionVerkaufSteuersatz": "USt. 19 %",
        "einsatzAbrechnungsPositionVerkaufEinheit": "pro Stunde",
        "einsatzAbrechnungsPositionVerkaufNetto": "170,00",
        "einsatzAbrechnungsPositionVerkaufUSt": "32,30",
        "einsatzAbrechnungsPositionVerkaufBrutto": "202,30"
      }
    ],
    "projekt": {
      "projektId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "projektName": "Verkostungsaktion",
      "projektNummer": "VK-2017-0123"
    },
    "job": {
      "jobId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "jobName": "Verkostungsaktion",
      "jobNummer": "VK-2017-0123"
    },
    "termin": {
      "terminId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "terminDatum": "02.07.2017",
      "terminZeitVon": "10:00",
      "terminZeitBis": "20:00",
      "terminBesetzungsstatus": "Termin ist unterbesetzt",
      "terminAnzahlPersonalbedarf": 1,
      "terminFunktionPersonalbedarf": "Fachberater"
    },
    "einsatz": {
      "einsatzId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "einsatzProjektId": "f40dde61-b474-47a3-aa6c-eb58c64eb10d",
      "einsatzJobId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzTerminId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzProfilId": "370b709f-5124-4dec-8c7f-0f54daf4c265",
      "einsatzEinsatzstatus": "Einsatz wurde gebucht",
      "einsatzCheckIn": "10:00",
      "einsatzCheckOut": "20:00",
      "einsatzKategorien": "Kategorie A, Kategorie B"
    },
    "aktionsstandort": {
      "aktionsstandortId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "aktionsstandortTitel": "Musterstandort",
      "aktionsstandortAdresszusatz": "Hinterhaus",
      "aktionsstandortStrasse": "Musterstraße 1",
      "aktionsstandortPLZ": "12345",
      "aktionsstandortStadt": "Musterstadt",
      "aktionsstandortLand": "Deutschland",
      "aktionsstandortIdentifikationsnummerIntern": "1000001",
      "aktionsstandortIdentifikationsnummerExtern": "ST-0001",
      "aktionsstandortBreitengrad": "52.000000",
      "aktionsstandortLaengengrad": "9.000000"
    },
    "profil": {
      "profilId": "c83af64f-fe1d-46cd-ab2c-dd7fa5d27958",
      "profilVorname": "Max",
      "profilNachname": "Mustermann",
      "profilPersonalnummer": "P123456",
      "profilStatus": "aktiv",
      "profilEmail": "promoter@example.com",
      "profilMobil": "+49 000 0000000"
    }
  }
]

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

13. Kalender (iCal)

Termine im iCal-Format, etwa für Kalenderprogramme. Die Beispiele übergeben den API-Key als GET-Parameter.

GET`/kalender/termine/{termin_id}`

Abfrage eines einzelnen Termins.

Abfrage eines einzelnen Termins. Rückgabe des abgefragten Termins im iCal-Format.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
termin_id	Pfad	string	ja	UUID eines Termins aus iPM_Promotion.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/termine/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958?api-key=<api-key>

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Kein Ergebnis gefunden

GET`/kalender/termine`

Abfrage von Terminen

Abfrage von Terminen. Rückgabe der abgefragten Termine im iCal-Format.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/termine?api-key=<api-key>&besetzungsstatus=besetzt

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben

GET`/kalender/projekte/{projekt_id}/termine`

Abfrage von Terminen zu einem Projekt im iCal-Format.

Abfrage von Terminen zu einem Projekt im iCal-Format. Rückgabe der abgefragten Termine eines Projekts.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?api-key=<api-key>&besetzungsstatus=besetzt

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kalender/jobs/{job_id}/termine`

Abfrage von Terminen zu einem Job.

Abfrage von Terminen zu einem Job. Rückgabe der abgefragten Termine eines Jobs im iCal-Format.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?api-key=<api-key>&besetzungsstatus=besetzt

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kalender/kunden/{kunden_id}/termine`

Abfrage von Terminen zu einem Kunden.

Abfrage von Terminen zu einem Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/kunden/<kunden-id>/termine?api-key=<api-key>&besetzungsstatus=besetzt

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kalender/kunden/{kunden_id}/projekte/{projekt_id}/termine`

Abfrage von Terminen zu einem Projekt eines Kunden.

Abfrage von Terminen zu einem Projekt eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
projekt_id	Pfad	string	ja	UUID eines Projekts aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/kunden/<kunden-id>/projekte/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?api-key=<api-key>&besetzungsstatus=besetzt

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

GET`/kalender/kunden/{kunden_id}/jobs/{job_id}/termine`

Abfrage von Terminen zu einem Job eines Kunden.

Abfrage von Terminen zu einem Job eines Kunden. 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.

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
kunden_id	Pfad	string	ja	UUID eines Kunden aus iPM_Promotion.
job_id	Pfad	string	ja	UUID eines Jobs aus iPM_Promotion.
besetzungsstatus	Abfrage	string	nein	Filter nach dem Besetzungsstatus der Termine. Werte: `besetzt`, `unterbesetzt`, `überbesetzt`
zeitraum	Abfrage	string	nein	Filter nach dem Zeitraum der Termine im Format dd.mm.yyyy-dd.mm.yyyy.

Adresse zum Abonnieren

https://ihre-domain.de/api/1/kalender/kunden/<kunden-id>/jobs/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958/termine?api-key=<api-key>&besetzungsstatus=besetzt

Antwort 200

Rückgabe eines/mehrerer Termine: Liste von Kalender.Termin, im iCal-Format. Jeder Kalendereintrag enthält die folgenden Felder.

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

Fehler

400 Userseitiger Fehler, z.B. falscher Input für Parameter
403 API-Key falsch oder nicht angegeben
404 Datensatz zu ID nicht gefunden

14. Datenstrukturen

Alle Felder der Rückgaben mit Beispielwerten aus der Spezifikation. Beispiele mit Personenbezug sind Platzhalter. Strukturen mit „Grunddaten“ stehen verschachtelt in anderen Rückgaben, die vollständigen liefert erweiterteDaten.

Aktionsstandort Grunddaten

11 Felder

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000

Aktionsstandort

21 Felder

Feld	Typ	Beispiel
aktionsstandortId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
aktionsstandortTitel	string	Musterstandort
aktionsstandortAdresszusatz	string	Hinterhaus
aktionsstandortStrasse	string	Musterstraße 1
aktionsstandortPLZ	string	12345
aktionsstandortStadt	string	Musterstadt
aktionsstandortLand	string	Deutschland
aktionsstandortIdentifikationsnummerIntern	string	1000001
aktionsstandortIdentifikationsnummerExtern	string	ST-0001
aktionsstandortBreitengradkann leer sein	float	52.000000
aktionsstandortLaengengradkann leer sein	float	9.000000
aktionsstandortTelefonZentrale	string	+49 000 0000000
aktionsstandortFax	string	+49 000 0000000
aktionsstandortEmail	string	standort@example.com
aktionsstandortVorOrtKontakt1	string	Max Muster
aktionsstandortVorOrtTelefon1	string	+49 000 0000000
aktionsstandortVorOrtKontakt2	string	Peter Später
aktionsstandortVorOrtTelefon2	string	+49 000 0000000
aktionsstandortGebiete	string	Gebiet 1 (12345), Gebiet 2 (45678)
aktionsstandortInterneNotiz	string	Ich bin die Notiz
projekt	Projekt Grunddaten	–

Einsatz-Abrechnung

59 Felder

Feld	Typ	Beispiel
einsatzAbrechnungId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
einsatzAbrechnungProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzAbrechnungJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
einsatzAbrechnungJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
einsatzAbrechnungTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzAbrechnungEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
einsatzAbrechnungAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
einsatzAbrechnungAbrechnungsstatus	string	Abrechnung abgeschlossen
einsatzAbrechnungWaehrung	string	EUR
einsatzAbrechnungEinkaufNettoGesamt	string	100,00
einsatzAbrechnungEinkaufUStGesamt	string	19,00
einsatzAbrechnungEinkaufBruttoGesamt	string	119,00
einsatzAbrechnungVerkaufNettoGesamt	string	100,00
einsatzAbrechnungVerkaufUStGesamt	string	19,00
einsatzAbrechnungVerkaufBruttoGesamt	string	119,00
einsatzAbrechnungEinkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungEinkaufUStGrundverguetung	string	19,00
einsatzAbrechnungEinkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungVerkaufNettoGrundverguetung	string	100,00
einsatzAbrechnungVerkaufUStGrundverguetung	string	19,00
einsatzAbrechnungVerkaufBruttoGrundverguetung	string	119,00
einsatzAbrechnungEinkaufNettoPraemien	string	100,00
einsatzAbrechnungEinkaufUStPraemien	string	19,00
einsatzAbrechnungEinkaufBruttoPraemien	string	119,00
einsatzAbrechnungVerkaufNettoPraemien	string	100,00
einsatzAbrechnungVerkaufUStPraemien	string	19,00
einsatzAbrechnungVerkaufBruttoPraemien	string	119,00
einsatzAbrechnungEinkaufNettoProvisionen	string	100,00
einsatzAbrechnungEinkaufUStProvisionen	string	19,00
einsatzAbrechnungEinkaufBruttoProvisionen	string	119,00
einsatzAbrechnungVerkaufNettoProvisionen	string	100,00
einsatzAbrechnungVerkaufUStProvisionen	string	19,00
einsatzAbrechnungVerkaufBruttoProvisionen	string	119,00
einsatzAbrechnungEinkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungEinkaufUStFahrtkosten	string	19,00
einsatzAbrechnungEinkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungVerkaufNettoFahrtkosten	string	100,00
einsatzAbrechnungVerkaufUStFahrtkosten	string	19,00
einsatzAbrechnungVerkaufBruttoFahrtkosten	string	119,00
einsatzAbrechnungEinkaufNettoAuslagen	string	100,00
einsatzAbrechnungEinkaufUStAuslagen	string	19,00
einsatzAbrechnungEinkaufBruttoAuslagen	string	119,00
einsatzAbrechnungVerkaufNettoAuslagen	string	100,00
einsatzAbrechnungVerkaufUStAuslagen	string	19,00
einsatzAbrechnungVerkaufBruttoAuslagen	string	119,00
einsatzAbrechnungEinkaufNettoSonstiges	string	100,00
einsatzAbrechnungEinkaufUStSonstiges	string	19,00
einsatzAbrechnungEinkaufBruttoSonstiges	string	119,00
einsatzAbrechnungVerkaufNettoSonstiges	string	100,00
einsatzAbrechnungVerkaufUStSonstiges	string	19,00
einsatzAbrechnungVerkaufBruttoSonstiges	string	119,00
einsatzAbrechnungPositionen	Liste von Einsatz-Abrechnung-Position	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
einsatz	Einsatz	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Einsatz-Abrechnung-Position

27 Felder

Feld	Typ	Beispiel
einsatzAbrechnungsPositionId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzAbrechnungsPositionTitel	string	Tagessatz
einsatzAbrechnungsPositionBeschreibung	string	Freitext/Beschreibung vom Promoter
einsatzAbrechnungsPositionBerechnungstyp	string	Netto-Plan-Arbeitszeit pro Stunde
einsatzAbrechnungsPositionKosteneinordnung	string	Grundvergütung
einsatzAbrechnungsPositionBerechnungInPlankosten	string	Nein
einsatzAbrechnungsPositionBerechnungInIstkosten	string	Ja
einsatzAbrechnungsPositionErloeskonto	string	8400
einsatzAbrechnungsPositionAufwandskonto	string	1740
einsatzAbrechnungsPositionKostenstelle	string	1700
einsatzAbrechnungsPositionKostentraeger	string	1700
einsatzAbrechnungsPositionLohnart	string	11
einsatzAbrechnungsPositionBearbeitungsschluessel	string	3
einsatzAbrechnungsPositionEinkaufAnzahl	string	8,50
einsatzAbrechnungsPositionEinkaufPreis	string	10,00
einsatzAbrechnungsPositionEinkaufSteuersatz	string	USt. 19 %
einsatzAbrechnungsPositionEinkaufEinheit	string	pro Stunde
einsatzAbrechnungsPositionEinkaufNetto	string	85,00
einsatzAbrechnungsPositionEinkaufUSt	string	16,15
einsatzAbrechnungsPositionEinkaufBrutto	string	101,15
einsatzAbrechnungsPositionVerkaufAnzahl	string	8,50
einsatzAbrechnungsPositionVerkaufPreis	string	20,00
einsatzAbrechnungsPositionVerkaufSteuersatz	string	USt. 19 %
einsatzAbrechnungsPositionVerkaufEinheit	string	pro Stunde
einsatzAbrechnungsPositionVerkaufNetto	string	170,00
einsatzAbrechnungsPositionVerkaufUSt	string	32,30
einsatzAbrechnungsPositionVerkaufBrutto	string	202,30

Einsatz

14 Felder

Feld	Typ	Beispiel
einsatzId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
einsatzProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
einsatzJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
einsatzEinsatzstatus	string	Einsatz wurde gebucht
einsatzCheckInkann leer sein	dateTime	10:00
einsatzCheckOutkann leer sein	dateTime	20:00
einsatzKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–

Feedback

16 Felder

Feld	Typ	Beispiel
feedbackId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
feedbackFragebogenId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
feedbackProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
feedbackJobId	uuid	fcfc8425-e27a-414d-8a4d-8814330d0230
feedbackJobProfilId	uuid	782839e3-5dee-41a8-8352-6b0c0d644a96
feedbackTerminId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
feedbackEinsatzId	uuid	d26d92ba-3b22-4d63-b0ef-da2f3921a000
feedbackAktionsstandortId	uuid	483774df-3ec0-469f-8449-98207243237f
feedbackFragenAuswertungen	Liste von Feedback-Fragen-Auswertung	–
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
termin	Termin Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–
profil	Profil Grunddaten	–
einsatz	Einsatz	–

Feedback-Fragen-Auswertung

2 Felder

Feld	Typ	Beispiel
keyKey der Feedback-Fragen-Auswertung-Collection abhängig von Titel der Frage-Elemente	string	summierung_von_fragetitel_zu_frage_unterfrage_mit_option_option_titel_id
valueValue der Feedback-Fragen-Auswertung-Collection mit dem Auswertungswert	string	5

Job Grunddaten

3 Felder

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123

Job-Profil

15 Felder

Feld	Typ	Beispiel
jobProfilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobProfilProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
jobProfilJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilProfilId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
jobProfilStatus	string	Job-Profil wurde gebucht
jobProfilAnzahlEinsaetze	integer	5
jobProfilAnzahlEinsaetzBewerbungMussBeantwortetWerden	integer	5
jobProfilAnzahlEinsaetzWartenAufRueckmeldungVonPromoter	integer	5
jobProfilAnzahlEinsaetzWartenAufEinsatzbestaetigungDurchPromoter	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchAgentur	integer	5
jobProfilAnzahlEinsaetzAbgesagtDurchPromoter	integer	5
jobProfilAnzahlEinsaetzeGebucht	integer	5
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
profil	Profil Grunddaten	–

Job

18 Felder

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–

Profil Grunddaten

7 Felder

Feld	Typ	Beispiel
profilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
profilVorname	string	Max
profilNachname	string	Mustermann
profilPersonalnummer	string	P123456
profilStatus	string	aktiv
profilEmail	email	promoter@example.com
profilMobil	string	+49 000 0000000

Profil

23 Felder

Feld	Typ	Beispiel
profilId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
profilVorname	string	Max
profilNachname	string	Mustermann
profilPersonalnummer	string	P123456
profilStatus	string	aktiv
profilGeschlecht	string	männlich
profilEmail	email	promoter@example.com
profilMobil	string	+49 000 0000000
profilTelefonPrivat	string	+49 000 0000000
profilFax	string	+49 000 0000000
profilTelefonGeschaeftlich	string	+49 000 0000000
profilStrasse	string	Musterstraße 1
profilAdresszusatz	string	Hinterhaus
profilPLZ	string	12345
profilStadt	string	Musterstadt
profilLand	string	Deutschland
profilZweitanschriftStrasse	string	Musterstraße 1
profilZweitanschriftAdresszusatz	string	Hinterhaus
profilZweitanschriftPLZ	string	12345
profilZweitanschriftStadt	string	Musterstadt
profilZweitanschriftLand	string	Deutschland
profilInterneNotiz	string	Ich bin die Notiz
profilKategorien	string	Kategorie A, Kategorie B

Projekt Grunddaten

3 Felder

Feld	Typ	Beispiel
projektId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
projektName	string	Verkostungsaktion
projektNummer	string	VK-2017-0123

Projekt

16 Felder

Feld	Typ	Beispiel
projektId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
projektName	string	Verkostungsaktion
projektNummer	string	VK-2017-0123
projektAnzahlPersonalbedarf	integer	1
projektFunktionPersonalbedarf	string	Promoter
projektBeschreibungIntern	string	Sondereinsätze für 2017
projektStart	string	01.01.2017
projektEnde	string	31.12.2017
projektZeitVon	string	10:00
projektZeitBis	string	20:00
projektTitel	string	Tolle Verkostungsaktion!
projektBranche	string	Lebensmittel
projektTaetigkeit	string	Verkostung
projektKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
projektBeschreibung	string	Bei dieser Aktion geht es um...
projektKategorien	string	Kategorie A, Kategorie B

Termin Grunddaten

7 Felder

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater

Termin

13 Felder

Feld	Typ	Beispiel
terminId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
terminProjektId	uuid	f40dde61-b474-47a3-aa6c-eb58c64eb10d
terminJobId	uuid	370b709f-5124-4dec-8c7f-0f54daf4c265
terminDatum	string	02.07.2017
terminZeitVon	string	10:00
terminZeitBis	string	20:00
terminBesetzungsstatus	string	Termin ist unterbesetzt
terminAnzahlPersonalbedarf	integer	1
terminFunktionPersonalbedarf	string	Fachberater
terminKategorien	string	Kategorie A, Kategorie B
projekt	Projekt Grunddaten	–
job	Job Grunddaten	–
aktionsstandort	Aktionsstandort Grunddaten	–

Verfügbarkeit

6 Felder

Feld	Typ	Beispiel
verfuegbarkeitId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
verfuegbarkeitProfilId	uuid	d5669b28-7600-4a8a-a803-8414cb268bc6
verfuegbarkeitDatum	string	01.10.2018
verfuegbarkeitVerfuegbar	string	ja
verfuegbarkeitNotiz	string	Freitext der Notiz
profil	Profil Grunddaten	–

IPMFeed

16 Felder

Feld	Typ	Beispiel
jobId	uuid	c83af64f-fe1d-46cd-ab2c-dd7fa5d27958
jobName	string	Verkostungsaktion
jobNummer	string	VK-2017-0123
jobAnzahlPersonalbedarf	integer	1
jobFunktionPersonalbedarf	string	Promoter
jobBeschreibungIntern	string	Sondereinsätze für 2017
jobStart	string	01.01.2017
jobEnde	string	31.12.2017
jobZeitVon	string	10:00
jobZeitBis	string	20:00
jobTitel	string	Tolle Verkostungsaktion!
jobBranche	string	Lebensmittel
jobTaetigkeit	string	Verkostung
jobKurzbeschreibung	string	Nicht lange warten - jetzt bewerben!
jobBeschreibung	string	Bei dieser Aktion geht es um...
jobZuordnungslink	string	http://promotersystemdomain.de/job/zuordnungslink/c83af64f-fe1d-46cd-ab2c-dd7fa5d27958

Kalender.Termin

8 Felder

Feld	Typ	Beispiel
summary	string	Jobname (Jobnummer) \| Aktionsstandort-Titel \| Anzahl x Einsatzfunktion \| [Besetzungsstatus] \| [Termin wurde bestätigt] \| [Termin wurde storniert]
description	string	Projekt: Projektname (Projektnummer) \| Job: Jobname (Jobnummer) \| Personalbedarf: Anzahl x Einsatzfunktion <br/>Besetzungsstatus: Besetzungsstatus \| Gebuchte Promoter: Max Mustermann, Erika Musterfrau \| Kategorien: Kategorie 1, Kategorie 2 \| Termin bestätigt: ja/nein
location	string	Aktionsstandort-Straße, Aktionsstandort-PLZ Aktionsstandort-Stadt, Aktionsstandort-Land
dtstart	string	20181001T080000Z
dtend	string	20181001T180000Z
dtstamp	string	20181001T180000Z
dtcreated	string	20181009T042127Z
last-modified	string	20181009T042127Z

API-Key anfragen

Den API-Key für Ihr System erhalten Sie in den Tarifen Premium und Enterprise auf Anfrage.

Kontakt aufnehmen Funktion: API und Exporte Hilfe: Zugriff auf die API

API-Dokumentation

Basis-URL

Endpunkt-Übersicht

1. Authentifizierung

1.1 API-Key erhalten

1.2 API-Key übermitteln

1.3 Fehlender oder falscher Key

2. Konventionen

2.1 Rückgabeformate

2.2 HTTP-Statuscodes

2.3 Limit und Offset

2.4 Zeiträume

2.5 Grunddaten und erweiterte Daten

2.6 Stornierte Datensätze und Weiterentwicklung

3. Projekte

GET/projekte/{projekt_id}

Parameter

Antwort 200

Fehler

GET/projekte

Parameter

Antwort 200

Fehler

GET/kunden/{kunden_id}/projekte

Parameter

Antwort 200

Fehler

4. Jobs

GET/jobs/{job_id}

Parameter

Antwort 200

Fehler

GET/jobs

Parameter

Antwort 200

Fehler

GET/projekte/{projekt_id}/jobs

Parameter

Antwort 200

Fehler

GET/kunden/{kunden_id}/jobs

Parameter

Antwort 200

Fehler

GET/kunden/{kunden_id}/projekte/{projekt_id}/jobs

Parameter

Antwort 200

Fehler

GET/job_feed/ipm

Parameter

Antwort 200

Fehler

5. Termine

GET/termine/{termin_id}

Parameter

Antwort 200

Fehler

GET/termine

Parameter

Antwort 200

Fehler

GET/projekte/{projekt_id}/termine

Parameter

Antwort 200

Fehler

GET/jobs/{job_id}/termine

Parameter

Antwort 200

Fehler

GET/kunden/{kunden_id}/termine

Parameter

Antwort 200

Fehler

GET/kunden/{kunden_id}/projekte/{projekt_id}/termine

Parameter

Antwort 200

Fehler

GET/kunden/{kunden_id}/jobs/{job_id}/termine

Parameter

Antwort 200

GET`/projekte/{projekt_id}`

GET`/projekte`

GET`/kunden/{kunden_id}/projekte`

GET`/jobs/{job_id}`

GET`/jobs`

GET`/projekte/{projekt_id}/jobs`

GET`/kunden/{kunden_id}/jobs`

GET`/kunden/{kunden_id}/projekte/{projekt_id}/jobs`

GET`/job_feed/ipm`

GET`/termine/{termin_id}`

GET`/termine`

GET`/projekte/{projekt_id}/termine`

GET`/jobs/{job_id}/termine`

GET`/kunden/{kunden_id}/termine`

GET`/kunden/{kunden_id}/projekte/{projekt_id}/termine`

GET`/kunden/{kunden_id}/jobs/{job_id}/termine`

GET`/einsaetze/{einsatz_id}`

GET`/einsaetze`

GET`/profile/{profil_id}/einsaetze`

GET`/projekte/{projekt_id}/einsaetze`

GET`/jobs/{job_id}/einsaetze`

GET`/kunden/{kunden_id}/einsaetze`

GET`/kunden/{kunden_id}/projekte/{projekt_id}/einsaetze`

GET`/kunden/{kunden_id}/jobs/{job_id}/einsaetze`

GET`/aktionsstandorte/{aktionsstandort_id}`

GET`/aktionsstandorte`

GET`/projekte/{projekt_id}/aktionsstandorte`

GET`/jobs/{job_id}/aktionsstandorte`

GET`/kunden/{kunden_id}/aktionsstandorte`

GET`/kunden/{kunden_id}/projekte/{projekt_id}/aktionsstandorte`

GET`/kunden/{kunden_id}/jobs/{job_id}/aktionsstandorte`

GET`/profile/{profil_id}`

GET`/profile`