Schnittstelle (API) zur Abfrage der Abteilungen

Die Abteilungen von onboard können über eine JSON-Schnittstelle abgefragt werden.

API-Endpunkte

Der Endpunkt ist über folgende URLs erreichbar:

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

Zusätzlich gibt es eigene Endpunkt pro Sprache. Die Sprache kann im ISO 639-1-Format angegeben werden (z.B. „de“, „it“, oder „en“). Der Endpunkt ist über folgende URLs erreichbar:

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

https://<Unternehmen>.onboard.org/de/exports/v2/departments.json
https://<Unternehmen>.onboard.org/it/exports/v2/departments.json
https://<Unternehmen>.onboard.org/en/exports/v2/departments.json
...

Den genauen API-Endpunkt mit Tracking-Parametern erhalten sie von unserem Support-Team auf Anfrage.

Bestimmte Felder sind übersetzbar (z.B. „name“). Ist keine Sprache in der URL angegeben, werden alle möglichen Übersetzungen ausgegeben (z.B. „name_de“, „name_en“). Ist eine Sprache angegeben, wird nur die ausgewählte Sprache zurückgegeben.

Parameter

• visible_on_career_site: Zeigt nur Abteilung an, die auf der Karriereseite sichtbar sind. Der Wert kann true oder false sein.
• only_roots: Zeigt nur Abteilung der obersten Ebene an. Der Wert kann true oder false sein.
• subtree_id: Zeigt nur die übergebene Abteilung sowie deren Unterabteilungen an.
• descendants_of_id: Zeigt nur die Unterabteilungen der übergeordneten Abteilung an.
• children_of_id: Zeigt nur die direkten Unterabteilungen der übergeordneten Abteilung an.

Beispiel:

https://<Unternehmen>.onboard.org/de/exports/v2/departments?show_on_career_site=true

Inhalt

Die Schnittstelle enthält alle benötigten Informationen zur Abteilung:

• id: Eindeutige ID
• name: Name der Abteilung
• depth: Ebene bzw. Tiefe in der Hierarchie (beginnt bei 0).
• subtree_ids: Liste der IDs aller enthaltenen Abteilungen
• ancestor_id: ID der übergeordneten Abteilung

Beispiel-Antwort der Schnittstelle:

[
  {
    "id": 123,
    "name": "Marketing",
    "depth": 0,
    "subtree_ids": [123, 456],
    "ancestor_id": null
  },
  {
    "id": 456,
    "name": "Online-Marketing",
    "depth": 1,
    "subtree_ids": [456],
    "ancestor_id": 123
  }
]