get/dictionary/{dictionaryId}

Dictionary lists are used accross Infojobs, for instance, to populate pull-down menus in formularies. This operation is used to retrieve all valid elements of a dictionary list. The different dictionary lists are identified by the parameter dictionaryId. A call to this operation providing one of the allowed values will retrieve a response composed of a numeric id, a standarized key, a human readable value and a parentId if it exists.


Request

Resource URL

https://api.infojobs.net/api/1/dictionary/{dictionaryId}

Security

  • User Role: public
  • Scope: none

Parameters

Name Description

dictionaryId

Required

String

Specifies the identifier of the desired list of values you intend to retrieve.

Allowed values:
- availability
- candidate-experience
- candidate-subsegment
- category
- channel
- city
- contract-type
- country
- driver-license
- employment-status
- employer-type
- experience-min
- gender
- grade
- id-type
- industry
- language
- last-job-search
- legal-form
- manager-professional-level
- mandatory-steps
- offer-residence
- offer-state
- periodos-intervalo
- professional-level
- province
- reading-level
- region
- report-reasons
- reporting-to
- salary-benefits
- salary-period
- salary-quantity
- salary-range
- skill-level
- speaking-level
- staff
- study
- study-detail
- subcategory
- teleworking
- timeline-event
- url-type
- work-permit
- workday
- writing-level

Example values: contract-type

parent

Optional

Integer

Some lists results can be filtered by specifying the parent element id.

    country: parent refers to the identifier of the travel zone (or economic area) where the country is located.

    province: parent refers to the identifier of the country where the province is located.

    region: parent refers to the identifier of the country where the local regions are located.

    city: parent refers to the identifier of the province where the city is located.

    subcategory: parent refers to the identifier of the category where the subcategory belongs.

    study-detail: parent refers to the identifier of the type of study the detail refers to.

Example values: 17 ( dictionary/province?parent=17)

Available dictionary identifiers:

Name Description

availability

The availability or willingness to perform an action, good, bad, etc.

candidate-experience

The experience the candidate has, only internships, one year, more than 5 years, etc.

candidate-subsegment

Candidate subsegments (blue, white-trainee, white-specialist, white-non-specialist, executive, etc.)

category

Category used by employers to classify the job post. For example: Legal, Medical, Sales, Marketing...

channel

Channels (Infojobs, Training Channel, Technology Channel, Channel Trades, etc.).

city

City of the job vacancy.

contract-type

Type of contract between the employer and the employee (fixed-term, trainee, etc.).

country

Country of the job vacancy.

driver-license

The driver licence type the candidate has, for instance: A, B, etc.

employment-status

Identifies the employment status of a candidate, unemployed, already have a job but willing to change, etc.

employer-type

Identifies the employer type as a regular company, a headhunter, a temporary work agency, self-employed, etc.

experience-min

Minimum required experience to qualify to the job.

gender

Gender detail.

grade

Score from 1 to 10.

id-type

Type of id (nif, nie, passport)

industry

Classifies the candidate's experience on its professional sector.

language

Language skills: English, French, etc.

last-job-search

How did you find the last job. (Press announcement, Online job bank, The company contacted me, etc.)

legal-form

Legal form types (S.A., S.C.R., ONG, etc.).

manager-professional-level

Classifies the candidate's manager level. It's related to the role responsabiliy

mandatory-steps

Mandatory curriculum step keys.

offer-residence

It is used for example if it's a requirement to be a resident of the province of the position. (Not required, Province vacant position, Cuntry vacant position, etc.).

offer-state

Offer statuses. (Active, archived, deleted, expired, etc.).

periodos-intervalo

Salary range. It related to salary-period.

professional-level

Classifies the candidate's professional level. It's related to the role responsabiliy.

province

Province of the job vacancy. Related to parent grouping country.

reading-level

Level read (Basic, Medium, etc.)

region

Region within a given country or abroad. Related to parent grouping country.

report-reasons

Reasons for reporting (Can't sign up for the offer, Fraudulent offer or company, Abusive conditions (salary, hours ...), etc.)

reporting-to

Who do you report to (Middle management, Area Director, General Director, etc.).

salary-benefits

Benefits that the company offers to the candidate when hired.

salary-period

The periods by which the salary will be perceived. For instance: Month, year, week, hour, etc.

salary-quantity

Monetary amount paid by the employer for a specified period.

salary-range

The salaries can be grouped into ranges. For instance under 12,000, between 12,001-15,000, etc.

study

Level of education of the job seeker (Bachelor's degree, Masters, etc.).

skill-level

Skill level (Basic, Medium, High)

speaking-level

Spoken level (Elementary, Conversation, Negotiation etc.)

staff

Ranges of number of personnel in charge (1 - 5, 6 - 10, etc.).

study-detail

Branch of study for a given level of education (Science, Business, etc.).

subcategory

Subcategory used by employers to classify job vacancy. Related to the parent list category.

teleworking

Teleworking modes such us face-to-face work only, telework only, teleworking possible

timeline-event

Candidate events, such as contacted, CV readed, interviewed, you have not been shortlisted, etc.

url-type

The type of url provided. For instance: twitter, facebook, gitHub, etc.

work-permit

The country or region where the candidate is allowed to work.

workday

Type of working day (full-time, part-time, etc.).

writing-level

The writing level (high, low, basic, etc.).

Response

Response entities

Name Description

id

Identifier of the element.

key

Normalized textual value.

value

Human readable textual value.

order

Order of the element in the list.

parent

Specify the parent of each element. For example, in list dictionary/province the field parent specifies the country of each element. This field is only available in some lists of values.

Error Codes

Code Description

201

Invalid parameter in API operation.

Examples

This example returns the list of values for the dictionary province in the country España (country id field 17).

Request

GET https://api.infojobs.net/api/1/dictionary/province?parent=17

Response

	  [
{
"parent": 17,
"key": "seleccionar",
"order": 0,
"value": "(Seleccionar)",
"id": 0
},
{
"parent": 17,
"key": "a-coruna",
"order": 1,
"value": "A Coruña",
"id": 28
},
{
"parent": 17,
"key": "alava",
"order": 2,
"value": "Álava",
"id": 2
},
{
"parent": 17,
"key": "albacete",
"order": 3,
"value": "Albacete",
"id": 3
},
{
"parent": 17,
"key": "alicante-alacant",
"order": 4,
"value": "Alicante/Alacant",
"id": 4
},
{
"parent": 17,
"key": "almeria",
"order": 5,
"value": "Almería",
"id": 5
},
{
"parent": 17,
"key": "asturias",
"order": 6,
"value": "Asturias",
"id": 6
},
{
"parent": 17,
"key": "avila",
"order": 7,
"value": "Ávila",
"id": 7
},
{
"parent": 17,
"key": "badajoz",
"order": 8,
"value": "Badajoz",
"id": 8
},
{
"parent": 17,
"key": "barcelona",
"order": 9,
"value": "Barcelona",
"id": 9
},
{
"parent": 17,
"key": "burgos",
"order": 10,
"value": "Burgos",
"id": 10
},
{
"parent": 17,
"key": "caceres",
"order": 11,
"value": "Cáceres",
"id": 11
},
{
"parent": 17,
"key": "cadiz",
"order": 12,
"value": "Cádiz",
"id": 12
},
{
"parent": 17,
"key": "cantabria",
"order": 13,
"value": "Cantabria",
"id": 13
},
{
"parent": 17,
"key": "castellon-castello",
"order": 14,
"value": "Castellón/Castelló",
"id": 14
},
{
"parent": 17,
"key": "ceuta",
"order": 15,
"value": "Ceuta",
"id": 15
},
{
"parent": 17,
"key": "ciudad-real",
"order": 16,
"value": "Ciudad Real",
"id": 16
},
{
"parent": 17,
"key": "cordoba",
"order": 17,
"value": "Córdoba",
"id": 17
},
{
"parent": 17,
"key": "cuenca",
"order": 18,
"value": "Cuenca",
"id": 18
},
{
"parent": 17,
"key": "girona",
"order": 19,
"value": "Girona",
"id": 19
},
{
"parent": 17,
"key": "granada",
"order": 20,
"value": "Granada",
"id": 21
},
{
"parent": 17,
"key": "guadalajara",
"order": 21,
"value": "Guadalajara",
"id": 22
},
{
"parent": 17,
"key": "guipuzcoa",
"order": 22,
"value": "Guipúzcoa",
"id": 23
},
{
"parent": 17,
"key": "huelva",
"order": 23,
"value": "Huelva",
"id": 24
},
{
"parent": 17,
"key": "huesca",
"order": 24,
"value": "Huesca",
"id": 25
},
{
"parent": 17,
"key": "illes-balears",
"order": 25,
"value": "Illes Balears",
"id": 26
},
{
"parent": 17,
"key": "jaen",
"order": 26,
"value": "Jaén",
"id": 27
},
{
"parent": 17,
"key": "la-rioja",
"order": 27,
"value": "La Rioja",
"id": 29
},
{
"parent": 17,
"key": "las-palmas",
"order": 28,
"value": "Las Palmas",
"id": 20
},
{
"parent": 17,
"key": "leon",
"order": 29,
"value": "León",
"id": 30
},
{
"parent": 17,
"key": "lleida",
"order": 30,
"value": "Lleida",
"id": 31
},
{
"parent": 17,
"key": "lugo",
"order": 31,
"value": "Lugo",
"id": 32
},
{
"parent": 17,
"key": "madrid",
"order": 32,
"value": "Madrid",
"id": 33
},
{
"parent": 17,
"key": "malaga",
"order": 33,
"value": "Málaga",
"id": 34
},
{
"parent": 17,
"key": "melilla",
"order": 34,
"value": "Melilla",
"id": 35
},
{
"parent": 17,
"key": "murcia",
"order": 35,
"value": "Murcia",
"id": 36
},
{
"parent": 17,
"key": "navarra",
"order": 36,
"value": "Navarra",
"id": 37
},
{
"parent": 17,
"key": "ourense",
"order": 37,
"value": "Ourense",
"id": 38
},
{
"parent": 17,
"key": "palencia",
"order": 38,
"value": "Palencia",
"id": 39
},
{
"parent": 17,
"key": "pontevedra",
"order": 39,
"value": "Pontevedra",
"id": 40
},
{
"parent": 17,
"key": "salamanca",
"order": 40,
"value": "Salamanca",
"id": 41
},
{
"parent": 17,
"key": "santa-cruz-de-tenerife",
"order": 41,
"value": "Santa Cruz de Tenerife",
"id": 46
},
{
"parent": 17,
"key": "segovia",
"order": 42,
"value": "Segovia",
"id": 42
},
{
"parent": 17,
"key": "sevilla",
"order": 43,
"value": "Sevilla",
"id": 43
},
{
"parent": 17,
"key": "soria",
"order": 44,
"value": "Soria",
"id": 44
},
{
"parent": 17,
"key": "tarragona",
"order": 45,
"value": "Tarragona",
"id": 45
},
{
"parent": 17,
"key": "teruel",
"order": 46,
"value": "Teruel",
"id": 47
},
{
"parent": 17,
"key": "toledo",
"order": 47,
"value": "Toledo",
"id": 48
},
{
"parent": 17,
"key": "valencia-valencia",
"order": 48,
"value": "Valencia/València",
"id": 49
},
{
"parent": 17,
"key": "valladolid",
"order": 49,
"value": "Valladolid",
"id": 50
},
{
"parent": 17,
"key": "vizcaya",
"order": 50,
"value": "Vizcaya",
"id": 51
},
{
"parent": 17,
"key": "zamora",
"order": 51,
"value": "Zamora",
"id": 52
},
{
"parent": 17,
"key": "zaragoza",
"order": 52,
"value": "Zaragoza",
"id": 53
}
]