Interfaccia (API) per interrogare i dipartimenti

I dipartimenti di onboard possono essere interrogati tramite un’interfaccia JSON.

Endpoint API

L’endpoint è raggiungibile tramite i seguenti URL:

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

Inoltre, esistono endpoint separati per ogni lingua. La lingua può essere specificata nel formato ISO 639-1 (ad esempio, “de”, “it” o “en”). L’endpoint è raggiungibile tramite i seguenti URL:

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

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

L’endpoint API esatto con i parametri di tracciamento è disponibile su richiesta presso il nostro team di assistenza.

Alcuni campi sono traducibili (ad esempio, “nome”). Se nell’URL non è specificata alcuna lingua, vengono restituite tutte le traduzioni possibili (ad esempio, “nome_de”, “nome_it”). Se viene specificata una lingua, viene restituita solo la lingua selezionata.

Parametri

• visible_on_career_site: visualizza solo i dipartimenti visibili nella pagina della carriera. Il valore può essere true o false.
• only_roots: visualizza solo i dipartimenti del livello superiore. Il valore può essere true o false.
• subtree_id: visualizza solo il dipartimento superiore e le sue suddivisioni.
• descendants_of_id: visualizza solo le dipartimenti subordinate del dipartimento superiore.
• children_of_id: visualizza solo i dipartimenti subordinati diretti del reparto superiore.

Esempio:

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

Contenuto

L’interfaccia contiene tutte le informazioni necessarie sul dipartimento:

• id: ID unico
• name: nome del dipartimento
• depth: livello o profondità nella gerarchia (inizia da 0)
• subtree_ids: elenco degli ID di tutti i dipartimenti contenuti
• ancestor_id: ID del dipartimento principale

Esempio di risposta dell’interfaccia:

[
  {
    "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
  }
]