REST - Anagrafica dipendenti via API
SeguiQuesto articolo descrive come leggere e scrivere l'anagrafica dei dipendenti tramite l'API REST di Altamira. Per il contesto generale e le regole comuni a tutti gli endpoint dell'organigramma fai riferimento all'articolo REST - Gestione anagrafiche e organigramma via API.
Endpoint da predisporre
- Creare un Endpoint/View per leggere i dati anagrafici base. È possibile aggiungere alla vista i campi necessari a seconda dell'esigenza.
- Creare un Endpoint/View per creare/aggiornare l'anagrafica dipendente.
Scrittura — creazione e aggiornamento
L'endpoint di scrittura accetta una chiamata POST con un payload nella forma seguente:
{
"data": [
{
"id": 0,
"Employees_FiscalCode": "CF0000000001",
"Employees_Surname": "Cognome",
"Employees_Name": "Nome",
"Employees_EmailBusiness": "Cognome.Nome@altamira.it",
"Employees_data_assunzione": "2020-01-01T00:00:00Z",
"Employees_ResignationDate": null
}
]
}Campi obbligatori
-
id—0per la creazione di un nuovo dipendente, l'identificativo del dipendente esistente per l'aggiornamento. -
Employees_FiscalCode— codice fiscale, usato come chiave di identificazione del dipendente. -
Employees_Surname— cognome. -
Employees_Name— nome. -
Employees_EmailBusiness— email aziendale. -
Employees_data_assunzione— data di assunzione. -
Employees_ResignationDate— data di dimissione:nullper i dipendenti attivi.
Campi aggiuntivi
I campi sopra rappresentano il set minimo. È possibile aggiungere alla vista altri campi anagrafici (telefono, indirizzo, sede, codifiche varie, campi personalizzati) secondo le esigenze del cliente: ogni campo aggiunto alla vista diventa scrivibile dall'API esponendone il TagName nel payload.
Dimissione di un dipendente
Per dimettere un dipendente è sufficiente eseguire un aggiornamento (id valorizzato con l'identificativo del dipendente) in cui il campo Employees_ResignationDate è valorizzato con una data precedente ad oggi:
{
"data": [
{
"id": 27160150,
"Employees_ResignationDate": "2026-03-31T00:00:00Z"
}
]
}Il dipendente viene marcato come dimesso a partire dalla data indicata.
Lettura
L'endpoint di lettura risponde a una chiamata GET e restituisce i dipendenti contenuti nella vista, con paginazione e filtri come descritto nell'articolo REST - Esempio chiamata di lettura. Aggiungere alla vista solo i campi che si vogliono effettivamente esporre verso il sistema esterno.
Note operative
- Le date devono essere nel formato
"2026-04-02T00:00:00Z". - L'aggiornamento è un full update dei campi inclusi nella vista: i campi non presenti nel payload mantengono il valore precedente, ma i campi presenti vengono sovrascritti con il valore inviato (anche se
null).
Permessi necessari
- Lettura sull'entità Dipendenti per le chiamate GET.
- Scrittura sull'entità Dipendenti per creazioni/aggiornamenti e per la dimissione.
I permessi vengono assegnati al singolo utente, non al profilo.
Articoli correlati
- REST - Gestione anagrafiche e organigramma via API
- REST - Modello dati di anagrafiche e organigramma
- REST - Organigramma e posizioni via API
- REST - Assegnazione dipendenti alle posizioni via API
- REST - Casistiche operative su organigramma via API
- REST - Esempio chiamata di lettura
- REST - Esempio chiamata di scrittura
Commenti
0 commenti
Accedi per aggiungere un commento.