1. Help Center
  2. Developer
  3. Interfaccia (API) per l’interrogazione delle sedi

Interfaccia (API) per l’interrogazione delle sedi

Le sedi di onboard possono essere interrogate tramite un’interfaccia JSON.

API Endpoint

L’endpoint può essere raggiunto tramite il seguente indirizzo:

https://<azienda>.onboard.org/exports/v2/locations.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 indirizzi:

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

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

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

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

Parametri

  • visible_on_career_site: visualizza solo le sedi visibili nel sito web. Il valore può essere true o false .
  • only_roots: visualizza solo le sedi di livello superiore. Il valore può essere true o false .
  • subtree_id: visualizza solo le sedi superiori e le loro sedi subordinate
  • descendants_of_id: visualizza solo le sedi subordinate delle sedi trasferite
  • children_of_id: visualizza solo le sedi subordinate dirette delle località trasferite

Esempio:

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

Contenuto

L’interfaccia contiene tutte le informazioni necessarie per l’annuncio di lavoro:

  • id: ID unico
  • name: Nome della sede
  • postal_code: CAP
  • country: Codice ISO del paese (ad es. “IT”)
  • depth: livello o profondità nella gerarchia (inizia da 0).
  • subtree_ids: elenco degli ID di tutte le sedi incluse
  • ancestor_id: ID delle sedi superiori
  • is_sub_business: true se si tratta di una sottoazienda, false in caso contrario.
  • sub_business_title: Nome della sottoazienda (se la sede è una).

Esempio di risposta dell’interfaccia:

[
  {
    "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"
  }
]
Aggiornato il 13/12/2023

Questo articolo è stato utile?

Articoli correlati

Non riesce a trovare la risposta che sta cercando?
Nessun problema! Il nostro team di supporto sarà felice di aiutarti.
Support-Team kontaktieren