Documentación del endpoint del recurso `Area`

El endpoint del recurso Area está diseñado para recuperar una lista de todas las áreas temáticas disponibles en la plataforma Datafaro. Este recurso es accesible mediante una solicitud HTTP GET y requiere autenticación a través de tokens personalizados.

Endpoint

GET /api/v1/area/

Autenticación

Este endpoint utiliza Token Authentication para asegurar que solo los usuarios con tokens válidos puedan acceder a los datos. Los clientes deben incluir su token en el encabezado de la solicitud HTTP como sigue:

Authorization: Token YOUR_ACCESS_TOKEN

Parámetros de solicitud

No se requieren parámetros para realizar una solicitud GET a este endpoint.

Ejemplo de solicitud

 
curl -X GET "http://datafaro.adatar.do/api/v1/area/" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Respuesta

La respuesta será una lista de áreas disponibles, representada en formato JSON.

Ejemplo de respuesta

[
    {
        "code": "ECONREAL",
        "name": "Economía Real",
        "description": "Datos relacionados con la producción y el consumo."
    },
    {
        "code": "MONE",
        "name": "Sector Monetario",
        "description": "Información sobre la política monetaria y las estadísticas financieras."
    }
    // ... más áreas
]

Códigos de estado HTTP

200 OK: La solicitud fue exitosa y la lista de áreas se retorna en el cuerpo de la respuesta.
401 Unauthorized: La solicitud no se autenticó correctamente. El token de acceso es inválido o no fue incluido.
403 Forbidden: La solicitud está autenticada, pero el usuario no tiene permisos para acceder a este recurso.
404 Not Found: El endpoint no existe o el recurso solicitado no está disponible.
500 Internal Server Error: Se ha producido un error en el servidor al procesar la solicitud.

Uso

Este endpoint es típicamente utilizado para:

Mostrar una lista de áreas temáticas a los usuarios para su navegación y selección.
Filtrar conjuntos de datos u otros recursos dentro de la aplicación basados en la selección de área temática.

Recursos disponibles en la API Institución

Documentación del endpoint del recurso Area