oneapi
Autentificare
Locations v1 / Ierarhie & dropdown-uri

Nomenclatoare de tipuri

Dicționarele cod→denumire pentru tipurile expuse ca cod brut în restul API-ului
(tip UAT, tip localitate, mediu, tip stradă). UI-urile le iau o dată și le mapează local.

GET
https://oneapi.ro/api/locations/v1/nomenclatoare/tipuri

Parametri de interogare

Ruta nu acceptă parametri de interogare.

Cum se comportă

  • Perechea deciziei „cod brut peste tot": aici iei denumirile pentru tip/mediu o dată și le mapezi local.

La ce folosește

  • Popularea filtrelor și legendelor din UI mapând coduri brute (tip/mediu) la denumiri.
  • Traducerea codurilor din răspunsuri (ex. tip UAT) în etichete lizibile, fetchate o singură dată.
  • Validarea locală a valorilor de tip înainte de a trimite filtre către API.

Structura răspunsului

Toate câmpurile de mai jos sunt în data.

CâmpTipDescriere
tip_uat[] array Tipurile de unitate administrativ-teritorială (municipiu, oraș, comună), cu codul și denumirea.
tip_uat[].cod string municipiu | oras | comuna.
tip_uat[].denumire string Denumirea lizibilă.
tip_localitate[] array Tipurile de localitate (reședință, sat aparținător, sat component).
tip_localitate[].cod string sat | localitate_componenta | resedinta_oras | resedinta_municipiu | sector.
tip_localitate[].denumire string Denumirea lizibilă.
mediu[] array Mediul: urban sau rural.
mediu[].cod string urban | rural.
mediu[].denumire string Denumirea lizibilă.
tip_strada[] array Tipurile de arteră (stradă, bulevard, alee, calea…), cu abrevierea folosită în nomenclator.
tip_strada[].cod string Cod normalizat (strada, bulevard…).
tip_strada[].denumire string Denumirea lizibilă.
*[].cod Codul brut, exact cum apare în celelalte răspunsuri ale modulului.
*[].denumire Ce înseamnă codul. Ruta există tocmai ca să nu trebuiască ghicit dintr-un răspuns.

Exemple de răspuns

GEThttps://oneapi.ro/api/locations/v1/nomenclatoare/tipuri
{
    "data": {
        "tip_uat": [
            {
                "cod": "municipiu",
                "denumire": "Municipiu"
            }
        ],
        "tip_localitate": [
            {
                "cod": "resedinta_municipiu",
                "denumire": "Reședință de municipiu"
            }
        ],
        "mediu": [
            {
                "cod": "urban",
                "denumire": "Urban"
            }
        ],
        "tip_strada": [
            {
                "cod": "alee",
                "denumire": "Alee"
            }
        ]
    }
}

Coduri de eroare

CodSlugCând apare
401neautentificatToken lipsă, invalid, expirat sau revocat.
403feature_indisponibilPlanul curent nu include funcţia de care ţine ruta.
422validareRuta nu primeşte parametri, în afară de lang: orice alt parametru dă 422, nu e ignorat.
429cota_depasitaCota lunară a planului a fost depăşită (vezi Retry-After).

Toate erorile au aceeași formă. eroare.cod e stabil și e cel după care trebuie să ramifici în cod — nu după textul din mesaj, care se poate schimba.

{
    "eroare": {
        "cod": "validare",
        "mesaj": "Ruta nu primeşte parametri, în afară de lang: orice alt parametru dă 422, nu e ignorat."
    }
}