Regiões

As regiões são o nível superior da hierarquia geográfica.

Hierarquia geográfica

Região → Setor → Município → Localidade

GET /api/regions

Obtém a lista das regiões.

Endpoint

GET /api/regions

Headers

Header	Valor	Obrigatório
Authorization	Bearer {token}	Sim

Resposta de sucesso

Código: 200 OK

{
    "@context": "/api/contexts/Region",
    "@id": "/api/regions",
    "@type": "hydra:Collection",
    "hydra:totalItems": 14,
    "hydra:member": [
        {
            "@id": "/api/regions/990e8400-e29b-41d4-a716-446655440001",
            "@type": "Region",
            "id": "990e8400-e29b-41d4-a716-446655440001",
            "nom": "Dakar",
            "code": "DK"
        },
        {
            "@id": "/api/regions/990e8400-e29b-41d4-a716-446655440002",
            "@type": "Region",
            "id": "990e8400-e29b-41d4-a716-446655440002",
            "nom": "Thiès",
            "code": "TH"
        },
        {
            "@id": "/api/regions/990e8400-e29b-41d4-a716-446655440003",
            "@type": "Region",
            "id": "990e8400-e29b-41d4-a716-446655440003",
            "nom": "Saint-Louis",
            "code": "SL"
        }
    ]
}

---

GET /api/regions/{id}

Obtém uma região pelo seu identificador.

Endpoint

GET /api/regions/{id}

Resposta de sucesso

Código: 200 OK

{
    "@context": "/api/contexts/Region",
    "@id": "/api/regions/990e8400-e29b-41d4-a716-446655440001",
    "@type": "Region",
    "id": "990e8400-e29b-41d4-a716-446655440001",
    "nom": "Dakar",
    "code": "DK"
}

---

Exemplos

cURL

# Lista das regiões
curl https://sig.ucp-pch.org/api/regions \
  -H "Authorization: Bearer TOKEN"

# Região por ID
curl https://sig.ucp-pch.org/api/regions/990e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: Bearer TOKEN"

JavaScript

const getRegions = async () => {
    const response = await fetch(
        'https://sig.ucp-pch.org/api/regions',
        {
            headers: {
                'Authorization': `Bearer ${localStorage.getItem('token')}`
            }
        }
    );
    return response.json();
};

// Utilização
const regions = await getRegions();
regions['hydra:member'].forEach(region => {
    console.log(`${region.code}: ${region.nom}`);
});

Python

import requests

def get_regions(token):
    response = requests.get(
        'https://sig.ucp-pch.org/api/regions',
        headers={'Authorization': f'Bearer {token}'}
    )
    return response.json()

# Utilização
regions = get_regions(token)
for region in regions['hydra:member']:
    print(f"{region['code']}: {region['nom']}")

Campos

Campo	Tipo	Descrição
id	UUID	Identificador único
nom	string	Nome da região
code	string	Código da região (ex: DK, TH)

Notas

• As regiões são somente leitura para utilizadores padrão
• A criação/modificação requer o papel ADMIN
• Utilizadas como referência para filtrar agregados familiares e beneficiários