Documentación del endpoint Status

El endpoint Status en la API de Datafaro ofrece una lista de los estados posibles que pueden tener los conjuntos de datos o indicadores dentro de la plataforma.

Endpoint

GET /api/v1/status/

Este endpoint es utilizado para acceder a una enumeración de los diferentes estados que puede tener un conjunto de datos en Datafaro.

Autenticación

El acceso a este endpoint requiere autenticación a través de Token Authenticación. Los usuarios deben incluir su token de acceso en el encabezado de la solicitud HTTP:

Authorization: Token YOUR_ACCESS_TOKEN

Respuesta

La API devuelve una lista de los posibles estados para los conjuntos de datos e indicadores, representados por un código y su descripción.

Ejemplo de solicitud

Para obtener la lista de estados:

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

Ejemplo de respuesta

La API devolverá una lista de estados en formato JSON:

[
    {
        "code": "A",
        "description": "Activo"
    },
    {
        "code": "S",
        "description": "Sucedido"
    },
    {
        "code": "I",
        "description": "Inactivo"
    },
    // ... más estados
]

Códigos de estado HTTP

• 200 OK: La solicitud fue exitosa y los datos se devuelven en el cuerpo de la respuesta.
• 401 Unauthorized: Falta el token de acceso o es inválido.

Uso

Este endpoint es crucial para:

• Entender los diferentes estados en que pueden encontrarse los conjuntos de datos o indicadores.
• Integrar esta información de estado en aplicaciones y sistemas que utilizan datos de Datafaro, permitiendo una gestión más efectiva de los recursos.

Notas adicionales

• La API proporciona una descripción clara y un código para cada estado, facilitando su interpretación y uso en diversas aplicaciones.
• Es importante que las aplicaciones que consumen datos de Datafaro manejen adecuadamente estos estados para garantizar una correcta interpretación y presentación de la información.