Schnittstelle (API) zur Abfrage der Anstellungsverhältnisse

Die Anstellungsverhältnisse von onboard können über eine JSON-Schnittstelle abgefragt werden.

API-Endpunkt

Der Endpunkt ist über folgend URL erreichbar:

https://<Unternehmen>.onboard.org/exports/v2/employee_jobs.json

Header

• API-KEY: Verpflichtend für die Autorisierung. Sie erhalten den API-Key von unserem Support-Team auf Anfrage.

Parameter

• page: Angezeigte Seite. Beginnt bei 1.

Beispiel:

https://<Unternehmen>.onboard.org/de/exports/v2/employee_jobs.json?page=1

Inhalt

Die Schnittstelle liefert folgende Inhalte:

• entries: Mitarbeiter-Informationen
• current_page: Aktuelle Seite
• per_page: Angezeigte Einträge pro Seite
• total_entries: Gesamtanzahl an Einträgen

Die Informationen der Mitarbeiter enthalten die Stammdaten sowie evtl. Informationen zum Anstellungsverhältnis:

• id: ID des Anstellungsverhältnisses
• employee_id: ID des Mitarbeiters
• from: Begin im Format YYYY-MM-DD
• to: Ende im Format YYYY-MM-DD. Wenn kein Ende angegeben ist (null), handelt es sich um ein unbefristetes Anstellungsverhältnis.
• name: Bezeichnung Anstellungsverhänis
• notes: Kommentar
• location_id: ID des Standorts
• department_id: ID der Abteilung
• job_type: Vertragsart. Mögliche Werte:
  • unknown: unbekannt / nicht gesetzt
  • unlimited: unbefristet
  • limited: befristet
  • limited_replacement: befristet wegen Ersatz
  • freelancer: Freiberufler
  • on_demand: Auf Abruf
  • job_sharing: Arbeitsplatzteilung (job sharing)
  • home: Heimarbeit
  • coordinated: Kontinuierliche und koordinierte Mitarbeit
  • internship: Praktikum
  • social: Sozialnützliche Tätigkeit / Arbeit
  • scholarship: Arbeitsstipendium und andere Arbeitserfahrunge
  • agency: Agenturvertrag
  • seasonal: Saisonsvertrag
  • apprenticeship: Traditionelle Lehre
  • apprenticeship_specialized: Berufsspezialisierende Lehre
  • apprenticeship_research: Lehre zur Höheren Berufsbildung und Forschung
• time_type: Vollzeit/Teilzeit. Mögliche Werte:
  • unknown: unbekannt / nicht gesetzt
  • full_time: Vollzeit
  • horizontal_part_time: horizontale Teilzeit
  • vertical_part_time: vertikale Teilzeit
  • mixed_part_time: gemischte Teilzeit
• time_table: Zeitplan (Text)
• classification: Einstufung
• time_hours: Wochenstunden
• time_percentage: Prozent Arbeitszeit

Evtl. enthält die Schnittstelle zusätzliche bzw. angepasste Informationen (je nachdem, welche Felder das Unternehmen benutzt).

Beispiel-Antwort:

{
   "entries":[
      {
         "id": 3,
         "employee_id: "RGb11O42",
         "from": "2023-01-15",
         "to": "2023-06-15",
         "job_type":"unlimited",
         "location_id":77,
         "department_id":9,
         "time_type": "full_time",
         "time_table": "Mo-Fr 8-16",
         "classification": "AB-1",
         "time_hours": 37.5,
         "time_percentage": 100
      }
   ],
   "current_page":1,
   "per_page":30,
   "total_entries":1
}