Documentación del endpoint `DatasetUpdate`

Este endpoint proporciona los datos más recientes disponibles para un DataSet específico. La información se puede retornar en varios formatos, incluyendo JSON y CSV.

Endpoint

GET /api/v1/update/

Usa este endpoint para solicitar los datos actualizados de un conjunto de datos por su identificador único.

Autenticación

La autenticación se realiza mediante Token Authentication. Incluye el token de acceso en el encabezado HTTP de la solicitud:

Authorization: Token YOUR_ACCESS_TOKEN

Parámetros de solicitud

id: El identificador único del DataSet para el cual se solicitan los datos actualizados.
fmt (opcional): El formato en el que se desean recibir los datos. Los valores pueden ser json (predeterminado) o csv.

Respuesta

Dependiendo del formato solicitado, la API responderá con los datos en el formato correspondiente:

Si el formato es json, se devuelve una respuesta con content_type como application/json.
Si el formato es csv, se devuelve una respuesta con content_type como text/csv.

Ejemplo de solicitud

Para obtener los datos más recientes en formato JSON:

curl -X GET "http://datafaro.adatar.do/api/v1/update/?id=specific_dataset_id&fmt=json" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Para obtener los datos más recientes en formato CSV:

curl -X GET "http://datafaro.adatar.do/api/v1/update/?id=specific_dataset_id&fmt=csv" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Ejemplos de respuesta

La respuesta contiene los datos más recientes disponibles para el conjunto de datos especificado. Los datos se devuelven en el formato seleccionado. Pero, pueden tener cualquier estructura, dependiendo del conjunto de datos solicitado. A continuación se muestran ejemplos de respuestas para los formatos JSON y CSV de un conjunto de datos hipotético.

Respuesta JSON

[
    {
        "fecha": "2023-04-01",
        "valor": 100.5,
        "grupo": "grupo1"
        // ... más campos de datos
    }
    // ... más registros
]

Respuesta CSV

fecha,valor,grupo,mas_campos
2023-04-01,100.5,grupo1,mas_valores
// ... más registros

Códigos de estado HTTP

200 OK: La solicitud fue exitosa y los datos se devuelven en el formato seleccionado.
401 Unauthorized: Falta token de acceso o es inválido.
404 Not Found: No se encontró el conjunto de datos especificado.
400 Bad Request: Formato de respuesta no válido solicitado.

Manejo de errores

La API proporciona mensajes de error detallados junto con códigos de estado HTTP apropiados para cualquier problema que surja durante la solicitud.

Ejemplo de respuesta de error

{
    "error": "No existe un dataset con el id 'specific_dataset_id'"
}

Conjunto de datos Metadatos

Documentación del endpoint DatasetUpdate