Molti campi in Altamira HRM sono elenchi a discesa. Usando l'API puoi farti dare l'elenco di tutte le liste usate dai campi delle viste che avete esposto usando la risorsa Lists.

REST v2 -Liste

I parametri per chiamare la risorsa Lists sono:

allora la URL per invocare la risorsa Lists è:

• https://platform.altamirahrm.com/api/v2/REST/Lists

questa url dovrà essere chiamata col metrodo POST

REST v1 - Liste

I parametri per chiamare la risorsa Lists sono:

Per esempio, se la URL di base del API REST è https://platform.altamirahrm.com/api/v1/altamira/REST

allora la URL per invocare la risorsa Lists è:

• https://platform.altamirahrm.com/api/v1/altamira/REST/Lists?ApiKey=0123456789&Language=ENG

Per entrambe le versioni l'output sarà strutturato così:

{
 "Lists": [
 {
 "ListName": "Business units",
 "TagName": "Vacancy.BusinessUnits",
 "Hierarchical": "0"
 },
 {
 "ListName": "Locations",
 "TagName": "Vacancy.Locations",
 "Hierarchical": "0"
 },
 {
 "ListName": "State",
 "TagName": "Jobs.State",
 "Hierarchical": "0"
 }
 ]
}

Ogni lista ha i seguenti attributi:

• ListName: il nome della lista nella lingua che hai impostato
• TagName: il nome univoco della lista, usato per ottenere gli elementi della lista
• Hierarchical: indica se la lista è gerarchica o meno. Se la lista è gerarchica possono essere usati gli operatori di confronto gerarchici

Con il TagName della lista è possibile ottenere gli elementi della lista dalla risorsa ListItems.

I parametri per chiamare la risorsa ListItems sono:

Ecco un esempio della URL per la risorsa ListItems:

• https://platform.altamirahrm.com/api/v1/altamira/REST/ListItems?ApiKey=0123456789&TagName=LISTTAGNAME&Language=ENG

L'output sarà strutturato così:

{
 "ListItems": [
 {
 "ID": "123456789",
 "DisplayName": "Sales & Marketing",
 "DisplayNamePath": "/Sales & Marketing/",
 "IDPath": "/123456789/",
 "NestLevel": "0",
 "CustomerID": "123"
 },
 {
 "ID": "987654321",
 "DisplayName": "Finance",
 "DisplayNamePath": "/Finance/",
 "IDPath": "/987654321/",
 "NestLevel": "0",
 "CustomerID": "321"
 }
 ]
}

Ogni elemento della lista ha i seguenti attributi:

• ID: L'ID dell'elemento
• DisplayName: Il testo dell'elemento nella lingua che hai impostato
• DisplayNamePath: Il percorso testuale completo dell'elemento nella lingua che hai impostato
• IDPath: Il percorso numerico completo dell'elemento nella lingua che hai impostato
• NestLevel: Il livello di nidificazione dell'elemento se la lista è gerarchica
• CustomerID: L'ID che il cliente ha dato a questo elemento