Schnittstelle (API) zur Abfrage der Standorte

Die Standorte 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/locations.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/locations.json

https://<Unternehmen>.onboard.org/de/exports/v2/locations.json
https://<Unternehmen>.onboard.org/it/exports/v2/locations.json
https://<Unternehmen>.onboard.org/en/exports/v2/locations.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 Standorte an, die auf der Karriereseite sichtbar sind. Der Wert kann true oder false sein.
• only_roots: Zeigt nur Standorte der obersten Ebene an. Der Wert kann true oder false sein.
• subtree_id: Zeigt nur die übergebene Standorte sowie deren Unterstandorte an.
• descendants_of_id: Zeigt nur die Unterstandorte der übergebenen Standorte an.
• children_of_id: Zeigt nur die direkten Unterstandorte der übergebenen Standorte an.

Beispiel:

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

Inhalt

Die Schnittstelle enthält alle benötigten Informationen zum Standort:

• id: Eindeutige ID
• name: Name des Standorts
• postal_code: Postleitzahl
• country: Land-ISO-Code (z.B. „IT“)
• depth: Ebene bzw. Tiefe in der Hierarchie (beginnt bei 0).
• subtree_ids: Liste der IDs aller enthaltenen Standorte
• ancestor_id: ID der übergeordneten Standorte
• is_sub_business: true wenn es sich um ein Sub-Unternehmen handelt, false wenn nicht.
• sub_business_title: Name des Sub-Unternehmen (falls der Standort eines ist).

Beispiel-Antwort der Schnittstelle:

[
  {
    "id": 123,
    "name": "Hauptsitz Lana",
    "street":"Boznerstraße 15/11",
    "postal_code": "39011",
    "city": "Lana",
    "region": "BZ",
    "country": "IT",
    "depth": 0,
    "subtree_ids": [123, 456],
    "ancestor_id": null,
    "is_sub_business": false,
    "sub_business_title": ""
  },
  {
    "id": 456,
    "name": "Online-Marketing",
    "street":"Enrico-Fermi-Straße 20",
    "postal_code": "39100",
    "city": "Bozen",
    "region": "BZ",
    "country": "IT",
    "depth": 1,
    "subtree_ids": [456],
    "ancestor_id": 123,
    "is_sub_business": true,
    "sub_business_title": "Sub-Unternehmen"
  }
]