Muchos campos en Altamira HRM son listas desplegables. Con la API, puedes obtener la lista de todas las listas utilizadas por los campos de las vistas que has expuesto utilizando el recurso Lists.

Los parámetros para llamar al recurso Listas son:

Por ejemplo, si la URL base de la API REST es https://platform.altamirahrm.com/api/v1/altamira/REST

entonces la URL para invocar el recurso Lists es:

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

El output se estructurará así:

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

Cada lista tiene los siguientes atributos:

• ListName: el nombre de la lista en el idioma que ha establecido
• TagName: el nombre único de la lista, utilizado para obtener los elementos de la lista
• Hierarchical: indica si la lista es jerárquica o no. Si la lista es jerárquica, se pueden usar operadores de comparación jerárquicos
  Con el TagName de la lista, es posible obtener los elementos de la lista del recurso ListItems.

Los parámetros para llamar al recurso ListItems son:

Aquí hay un ejemplo de la URL para el recurso ListItems:

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

La salida se estructurará así:

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

Cada elemento de la lista tiene los siguientes atributos:

• ID: el ID del elemento
• DisplayName: el texto del elemento en el idioma que has establecido
• DisplayNamePath: la ruta de texto completa del elemento en el idioma que has establecido
• IDPath: la ruta numérica completa del elemento en el idioma que has establecido
• NestLevel: el nivel de anidamiento del elemento si la lista es jerárquica
• CustomerID: el ID que el cliente dio a este elemento