Saltar a contenido

Inicializar declaración

POST /apientidades/v1/declaraciones/{iddeclaracion}/inicializar

Crea la estructura de datos necesaria para que la entidad pueda empezar a rellenar la declaración. Esta operación genera los registros internos de publicidad activa, cuestionarios y derecho de acceso vinculados a la declaración.

Parámetros de ruta

Parámetro Tipo Descripción
iddeclaracion int ID de la declaración

Body

No requiere body. La petición se envía sin contenido.

Ejemplo de petición

curl -s -X POST "https://apientidades-pro.transparenciacanarias.org/apientidades/v1/declaraciones/5001/inicializar" \
  -H "Authorization: Bearer $TOKEN" | jq .
import requests

BASE_URL = "https://apientidades-pro.transparenciacanarias.org/apientidades/v1"
headers = {"Authorization": f"Bearer {token}"}

response = requests.post(
    f"{BASE_URL}/declaraciones/5001/inicializar",
    headers=headers
)

if response.status_code == 200:
    print("Declaración inicializada correctamente")
else:
    print(f"Error: {response.json()}")
var response = await client.PostAsync(
    $"{baseUrl}/declaraciones/5001/inicializar",
    null  // Sin body
);

if (response.IsSuccessStatusCode)
{
    Console.WriteLine("Declaración inicializada");
}

Respuesta exitosa (200)

{
  "message": "Declaracion inicializada correctamente."
}

Estados permitidos

Este endpoint solo funciona cuando la declaración está en uno de estos estados:

Estado Código Resultado
SinAbrir 0 Se inicializa correctamente
NoPresentada 1 Se reinicializa (si no tenía estructura)

No inicializar dos veces

Si la declaración ya fue inicializada previamente (por ejemplo, desde el portal web de entidades), el endpoint devolverá un error 500. Esto es un comportamiento esperado: la declaración ya tiene estructura y está lista para ser cumplimentada. Verifique el estado con GET /declaraciones/{id} antes de llamar a este endpoint.

Flujo recomendado

sequenceDiagram
    participant S as Sistema externo
    participant API as API T-Canaria

    S->>API: GET /declaraciones/{id}
    API-->>S: estadoCodigo: 0 (SinAbrir)
    S->>API: POST /declaraciones/{id}/inicializar
    API-->>S: "Declaración inicializada"
    S->>API: GET /declaraciones/{id}
    API-->>S: estadoCodigo: 1 (NoPresentada)
    Note over S: Ahora puede rellenar PA, cuestionarios, DA

Errores posibles

Código Descripción
400 La declaración está en un estado que no permite inicialización (ej: ya presentada)
401 Token ausente, expirado o inválido
404 La declaración no existe o no pertenece a la entidad
500 La declaración ya fue inicializada previamente

Buena práctica

Siempre verifique el estado de la declaración con GET /declaraciones/{id} antes de intentar inicializar. Solo necesita inicializar si el estadoCodigo es 0 (SinAbrir).