Many fields in Altamira HRM are drop-down lists. Using the API you can get the list of all the lists used by the fields of the views that you have exposed using the Lists resource.

REST v2 -Lists

The parameters to call the Lists resource are:

then the URL to invoke the Lists resource is:

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

this url must be called with POST method.

REST v1 - Lists

The parameters to call the Lists resource are:

For example, if the base URL of the REST API is https://platform.altamirahrm.com/api/v1/altamira/REST,

then the URL to invoke the Lists resource is:

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

For both two versions of the API, the output will be structured as shown below:

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

Each list has the following attributes:

• ListName: The name of the list in the language you have set
• TagName: The unique name of the list, used to get the elements of the list
• Hierarchical: Indicates whether the list is hierarchical or not. If the list is hierarchical, hierarchical comparison operators can be used

With the List TagName you can get the list elements from the ListItems resource.

The parameters to call the ListItems resource are:

Here is an example of the URL for the ListItems resource:

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

The output will be structured as shown below:

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

Each element of the list has the following attributes:

• ID: The ID of the element
• DisplayName: The element text in the language you have set
• DisplayNamePath: The complete textual path of the element in the language you have set
• IDPath: The complete numeric path of the element in the language you have set
• NestLevel: The level of nesting of the element if the list is hierarchical
• CustomerID: The ID that the customer gave to this element