List ILOSTAT reference codes
ilostat_list_referenceDecode ILOSTAT's code vocabulary: reference areas (ISO3 countries and X-coded aggregates, with World Bank income group and ILO region), the groups that area_group accepts (X01 for every country, ILO regions and subregions, World Bank income groups; exact-code lookups list their member countries), databases, subjects, sex codes, breakdown codes for classif1/classif2 with their classification types, per-country data sources, observation status flags, note codes, and frequencies. Filter by text or look up exact codes; long topics page with a cursor. These are ILOSTAT-wide vocabularies; ilostat_describe_indicator lists the sex and breakdown codes one dataset actually uses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| codes | No | Exact codes to look up (up to 100; case-insensitive, and ILO_GEO_ forms accepted for ref_areas and area_groups). Codes the topic lacks are listed in not_found. With topic area_groups, each group found also lists its member countries. | |
| limit | No | Entries per page (1–500). | |
| topic | Yes | Vocabulary to list: ref_areas, area_groups (the X codes area_group accepts), databases, subjects, sexes, classifications (classif1/classif2 codes), classification_types, sources, obs_status, notes, or frequencies. | |
| cursor | No | Opaque continuation token: the previous page's next_cursor, passed unchanged. | |
| filter | No | Text filter: every word must match a word or word prefix of the code or label (case, accents, and punctuation ignored; labor matches labour). Omit to list the whole topic. | |
| ref_area | No | Topic sources only: list the sources of this reference area (ISO3 or X code; case-insensitive, ILO_GEO_ forms accepted). | |
| classification_type | No | Topic classifications only: keep codes of this classification type, the code prefix (AGE, ECO, EDU, …). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The limit applied to this page. | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Entries returned on this page. | |
| topic | No | The topic listed. | |
| total | No | Entries matching the filters, across all pages. | |
| notice | No | Why a filter with no searchable word was not applied, why nothing matched, that the cursor starts past the last entry, and how to reach the remaining pages — whichever apply, joined. | |
| entries | No | This page of decoded codes, ordered by code — except sexes, which keep the ILOSTAT dictionary's order (SEX_T first), and frequencies, listed annual, quarterly, monthly. | |
| not_found | No | Requested codes the topic does not contain; present only when codes missed. | |
| truncated | No | True when more entries remain beyond this page. | |
| next_cursor | No | Pass as cursor to get the next page; absent on the last page. | |
| catalog_as_of | No | ISO timestamp the in-memory catalog was last confirmed current. |