API-Referenz

Einfacher & schneller Zugriff per REST-Schnittstelle

GigPlaner REST-API Referenz

Die GigPlaner REST-API bietet Ihnen die Möglichkeit, von außen auf die Daten des Systems zuzugreifen und neue Daten anzulegen oder vorhandene Daten zu verändern. Hierzu stehen viele verschiedene Funktionen zur Verfügung, mit denen Sie sowohl auf Stammdaten (Mitarbeiter, Freelancer, Kategorien, etc.) als auch Bewegungsdaten (Jobs, etc.) zugreifen können.

Authentifizierung

Da die Kommunikation mit dem GigPlaner ausschließlich über verschlüsselte SSL-Verbindungen möglich ist, stellt die HTTP-Basis-Authentifizierung die bevorzugte Anmeldemethode dar. Hierzu geben Sie einfach jedem Aufruf der REST-API einen gültigen Benutzernamen und das zugehörige Passwort mit.

URI-Struktur

Die GigPlaner REST-API erlaubt den Zugriff auf Ressourcen (Datentypen) über URI-Pfade. Um die REST-API zu nutzen muss Ihre Anwendung eine HTTP-Anfrage stellen und die Antwort auswerten. Die GigPlaner-API nutzt das JSON-Format und HTTP-Statuscodes als Rückgabeformat sowie die HTTP-Methoden wie GET, POST, PUT und DELETE. URIs für die GigPlaner REST-API haben die folgende Struktur:

https://your-name.gigplaner.com/api/ressource-name

Technische IDs

Jedes Objekt wird in der Datenbank des GigPlaners mit einer eindeutigen ID hinterlegt. Diese ist im gleichnamigen Feld ID in jedem Objekt gespeichert und dient auch zur Identifikation der Objekte in der API (z.B. als jobID, docID, etc.). Parallel dazu existiert in allen Stammdaten-Objekten das Feld FremdID, welches eine bis zu 32 Zeichen lange ID eines Fremdsystems aufnehmen kann. In diesem Feld können Sie die technische ID von Fremdsystemen hinterlegen, die entsprechenden Objekte lassen sich dann auch in der API direkt über die Fremd-ID selektieren:

https://your-name.gigplaner.com/api/ressource-name/FremdID:abcdefghijklmnopqrstuvwxyz

Datumswerte

Als Grundlage für die Datumswerte setzt die Schnittstelle auf das Format ISO 8601. Ein Datum wird von der API in der Form 2019-01-01 ausgegeben, ein Datum mit Zeitangabe in der Form 20190101T235959Z. Wenn Sie Daten an die API senden akzeptiert die Schnittstelle neben diesen Formaten auch die Formate 2019-01-01T23:59:59Z sowie 2019-01-01T23:59:59+00:00. Die Werte werden von der Schnittstelle automatisch in die im GigPlaner hinterlegte Zeitzone konvertiert.

Ressourcen

api/jobs/

Bietet Zugriff auf die Jobs des aktuell angemeldeten Benutzers

> Jobs auslesenGET api/jobs/

api/job/

Bietet Zugriff auf Jobs und deren Informationen

> Job auslesenGET api/job/{jobId}
> Job anlegenPOST api/job/
> Job aktualisierenPUT api/job/{jobId}
> Job löschenDELETE api/job/{jobId}
> Jobs durchsuchenPOST api/job/suche
> Alle Dokumente auslesenGET api/job/{jobId}/dokumente/
> Dokument auslesenGET api/job/{jobId}/dokument/{docId}
> Dokument speichernPOST api/job/{jobId}/dokument/
> Dokument aktualisierenPUT api/job/{jobId}/dokument/{docId}
> Dokument löschenDELETE api/job/{jobId}/dokument/{docId}
> Alle Kategorien auslesenGET api/job/{jobId}/kategorien/
> Kategorie auslesenGET api/job/{jobId}/kategorie/{kategorieId}
> Kategorie anlegenPOST api/job/{jobId}/kategorie/
> Kategorie aktualisierenPUT api/job/{jobId}/kategorie/{kategorieId}
> Kategorie löschenDELETE api/job/{jobId}/kategorie/{kategorieId}
> Mitarbeiter auslesenGET api/job/{jobId}/mitarbeiter/{terminMitarbeiterId}
> Mitarbeiter anlegenPOST api/job/{jobId}/mitarbeiter/
> Mitarbeiter aktualisierenPUT api/job/{jobId}/mitarbeiter/{terminMitarbeiterId}
> Mitarbeiter löschenDELETE api/job/{jobId}/mitarbeiter/{terminMitarbeiterId}
> Mehrere Mitarbeiter aktualisierenPUT api/job/{jobId}/mitarbeiter/
> Disponent auslesenGET api/job/{jobId}/disponent/{disponentenID}
> Disponent anlegenPOST api/job/{jobId}/disponent/
> Disponent aktualisierenPUT api/job/{jobId}/disponent/{disponentenID}
> Disponent löschenDELETE api/job/{jobId}/disponent/{disponentenID}
> Projektleiter auslesenGET api/job/{jobId}/projektleiter/{projektleiterID}
> Projektleiter anlegenPOST api/job/{jobId}/projektleiter/
> Projektleiter aktualisierenPUT api/job/{jobId}/projektleiter/{projektleiterID}
> Projektleiter löschenDELETE api/job/{jobId}/projektleiter/{projektleiterID}
> Kunden-Ansprechpartner auslesenGET api/job/{jobId}/kundenansprechpartner/{ansprechpartnerID}
> Kunden-Ansprechpartner anlegenPOST api/job/{jobId}/kundenansprechpartner/
> Kunden-Ansprechpartner aktualisierenPUT api/job/{jobId}/kundenansprechpartner/{ansprechpartnerID}
> Kunden-Ansprechpartner löschenDELETE api/job/{jobId}/kundenansprechpartner/{ansprechpartnerID}
> Location-Ansprechpartner auslesenGET api/job/{jobId}/locationansprechpartner/{ansprechpartnerID}
> Location-Ansprechpartner anlegenPOST api/job/{jobId}/locationansprechpartner/
> Location-Ansprechpartner aktualisierenPUT api/job/{jobId}/locationansprechpartner/{ansprechpartnerID}
> Location-Ansprechpartner löschenDELETE api/job/{jobId}/locationansprechpartner/{ansprechpartnerID}
> Zusatzdaten auslesenGET api/job/{jobId}/zusatzdaten/{zusatzdatentypID}
> Zusatzdaten aktualisierenPUT api/job/{jobId}/zusatzdaten/{zusatzdatentypID}
> Zusatzdaten löschenDELETE api/job/{jobId}/zusatzdaten/{zusatzdatentypID}

api/arbeitszeit/

Bietet Zugriff auf Arbeitszeiten und deren Informationen

> Arbeitszeit auslesenGET api/arbeitszeit/{zeitId}
> Arbeitszeit anlegenPOST api/arbeitszeit/
> Arbeitszeit aktualisierenPUT api/arbeitszeit/{zeitId}
> Arbeitszeit löschenDELETE api/arbeitszeit/{zeitId}
> Arbeitszeiten durchsuchenPOST api/arbeitszeit/suche

api/urlaub/

Bietet Zugriff auf Urlaube und Krankmeldungen und deren Informationen

> Urlaub / Krankmeldung auslesenGET api/urlaub/{urlaubId}
> Urlaub / Krankmeldung anlegenPOST api/urlaub/
> Urlaub / Krankmeldung aktualisierenPUT api/urlaub/{urlaubId}
> Urlaub / Krankmeldung löschenDELETE api/urlaub/{urlaubId}
> Urlaube / Krankmeldungen durchsuchenPOST api/urlaub/suche

api/stammdaten/mitarbeiter/

Bietet Zugriff auf Mitarbeiter und deren Informationen

> Mitarbeiter auslesenGET api/stammdaten/mitarbeiter/{mitarbeiterId}
> Mitarbeiter anlegenPOST api/stammdaten/mitarbeiter/
> Mitarbeiter aktualisierenPUT api/stammdaten/mitarbeiter/{mitarbeiterId}
> Mitarbeiter löschenDELETE api/stammdaten/mitarbeiter/{mitarbeiterId}
> Mitarbeiter durchsuchenPOST api/stammdaten/mitarbeiter/suche
> Benutzergruppe zuweisenPOST api/stammdaten/mitarbeiter/{mitarbeiterId}/benutzergruppe
> Benutzergruppe löschenDELETE api/stammdaten/mitarbeiter/{mitarbeiterId}/benutzergruppe/{benutzergruppenId}

api/stammdaten/freelancer/

Bietet Zugriff auf Freelancer und deren Informationen

> Freelancer auslesenGET api/stammdaten/freelancer/{freelancerId}
> Freelancer anlegenPOST api/stammdaten/freelancer/
> Freelancer aktualisierenPUT api/stammdaten/freelancer/{freelancerId}
> Freelancer löschenDELETE api/stammdaten/freelancer/{freelancerId}
> Freelancer durchsuchenPOST api/stammdaten/freelancer/suche
> Benutzergruppe zuweisenPOST api/stammdaten/freelancer/{freelancerId}/benutzergruppe
> Benutzergruppe löschenDELETE api/stammdaten/freelancer/{freelancerId}/benutzergruppe/{benutzergruppenId}

api/stammdaten/dienstleister/

Bietet Zugriff auf Dienstleister und deren Informationen

> Dienstleister auslesenGET api/stammdaten/dienstleister/{dienstleisterId}
> Dienstleister anlegenPOST api/stammdaten/dienstleister/
> Dienstleister aktualisierenPUT api/stammdaten/dienstleister/{dienstleisterId}
> Dienstleister löschenDELETE api/stammdaten/dienstleister/{dienstleisterId}
> Dienstleister durchsuchenPOST api/stammdaten/dienstleister/suche
> Benutzergruppe zuweisenPOST api/stammdaten/dienstleister/{dienstleisterId}/benutzergruppe
> Benutzergruppe löschenDELETE api/stammdaten/dienstleister/{dienstleisterId}/benutzergruppe/{benutzergruppenId}

api/stammdaten/benutzergruppen/

Erzeugt eine Liste aller verfügbaren Benutzergruppen.

> Alle Benutzergruppen auslesenGET api/stammdaten/benutzergruppen/

api/stammdaten/kunde/

Bietet Zugriff auf Kunden und deren Informationen

> Kunde auslesenGET api/stammdaten/kunde/{kundenId}
> Kunde anlegenPOST api/stammdaten/kunde/
> Kunde aktualisierenPUT api/stammdaten/kunde/{kundenId}
> Kunde löschenDELETE api/stammdaten/kunde/{kundenId}
> Kunden durchsuchenPOST api/stammdaten/kunde/suche
> Ansprechpartner auslesenGET api/stammdaten/kunde/{kundenID}/ansprechpartner/{ansprechpartnerID}
> Ansprechpartner anlegenPOST api/stammdaten/kunde/{kundenID}/ansprechpartner/{ansprechpartnerID}
> Ansprechpartner aktualisierenPUT api/stammdaten/kunde/{kundenID}/ansprechpartner/{ansprechpartnerID}
> Ansprechpartner löschenDELETE api/stammdaten/kunde/{kundenID}/ansprechpartner/{ansprechpartnerID}

api/stammdaten/location/

Bietet Zugriff auf Locations und deren Informationen

> Location auslesenGET api/stammdaten/location/{locationId}
> Location anlegenPOST api/stammdaten/location/
> Location aktualisierenPUT api/stammdaten/location/{locationId}
> Location löschenDELETE api/stammdaten/location/{locationId}
> Locations durchsuchenPOST api/stammdaten/location/suche
> Ansprechpartner auslesenGET api/stammdaten/location/{locationID}/ansprechpartner/{ansprechpartnerID}
> Ansprechpartner anlegenPOST api/stammdaten/location/{locationID}/ansprechpartner/{ansprechpartnerID}
> Ansprechpartner aktualisierenPUT api/stammdaten/location/{locationID}/ansprechpartner/{ansprechpartnerID}
> Ansprechpartner löschenDELETE api/stammdaten/location/{locationID}/ansprechpartner/{ansprechpartnerID}

api/stammdaten/kategorien/

Bietet Zugriff auf die Liste aller Kategorien für Mitarbeiter, Freelancer und Dienstleister

> Alle Kategorien auslesenGET api/stammdaten/kategorien/

api/stammdaten/kategorie/

Bietet Zugriff auf die Kategorien für Mitarbeiter, Freelancer und Dienstleister

> Kategorie auslesenGET api/stammdaten/kategorie/{kategorieId}
> Kategorie anlegenPOST api/stammdaten/kategorie/
> Kategorie aktualisierenPUT api/stammdaten/kategorie/{kategorieId}
> Kategorie löschenDELETE api/stammdaten/kategorie/{kategorieId}

api/stammdaten/jobtypen/

Bietet Zugriff auf die Liste aller Jobtypen inkl. Unterteilungen.

> Alle Jobtypen auslesenGET api/stammdaten/jobtypen/

api/stammdaten/jobtyp/

Bietet Zugriff auf die Jobtypen und Unterteilungen

> Jobtyp / Unterteilung auslesenGET api/stammdaten/jobtyp/{jobtypId}
> Jobtyp / Unterteilung anlegenPOST api/stammdaten/jobtyp/
> Jobtyp / Unterteilung aktualisierenPUT api/stammdaten/jobtyp/{jobtypId}
> Jobtyp / Unterteilung löschenDELETE api/stammdaten/jobtyp/{jobtypId}

api/stammdaten/zeitkategorien/

Bietet Zugriff auf die Liste aller Kategorien für Arbeitszeiten

> Alle Zeitkategorien auslesenGET api/stammdaten/zeitkategorien/

api/stammdaten/zeitkategorie/

Bietet Zugriff auf die Kategorien für Arbeitszeiten

> Zeitkategorie auslesenGET api/stammdaten/zeitkategorie/{kategorieId}
> Zeitkategorie anlegenPOST api/stammdaten/zeitkategorie/
> Zeitkategorie aktualisierenPUT api/stammdaten/zeitkategorie/{kategorieId}
> Zeitkategorie löschenDELETE api/stammdaten/zeitkategorie/{kategorieId}

api/stammdaten/urlaubskategorien/

Bietet Zugriff auf die Liste aller Kategorien für Urlaube

> Alle Urlaubskategorien auslesenGET api/stammdaten/urlaubskategorien/

api/stammdaten/urlaubskategorie/

Bietet Zugriff auf die Kategorien für Urlaube

> Urlaubskategorie auslesenGET api/stammdaten/urlaubskategorie/{kategorieId}
> Urlaubskategorie anlegenPOST api/stammdaten/urlaubskategorie/
> Urlaubskategorie aktualisierenPUT api/stammdaten/urlaubskategorie/{kategorieId}
> Urlaubskategorie löschenDELETE api/stammdaten/urlaubskategorie/{kategorieId}

api/account/

Bietet Zugriff auf die Daten des aktuell angemeldeten Benutzers

> Benutzer auslesenGET api/account/
> Benutzer aktualisierenPUT api/account/

api/zusatzdatentypen/

Liefert eine Liste aller möglichen Zusatzdaten für verschiedene Datentypen.

> Alle Zusatzdatentypen auslesenGET api/zusatzdatentypen/




 

Kontakt

GigPlaner - Personalplanung für Veranstaltungen

Der GigPlaner erleichtert und beschleunigt die Personalplanung für Veranstaltungen. Durch die übersichtliche Darstellung im Webbrowser ist die Verfügbarkeit der Mitarbeiter oder Mitglieder jederzeit auf einen Blick ersichtlich. Und mit der Smartphone-App des GigPlaners kann sogar unterwegs auf die Daten zugegriffen werden.

Der günstigste Tarif des GigPlaners ist bereits ab 5€ pro Monat verfügbar. Der höchste Tarif (XL) mit vollem Funktionsumfang ist bereits ab 25€ pro Monat verfügbar.