6. API DE EVENTOS

Nombre

Evento DE

Tipo de Petición

POST

Descripción:

  • Este método se usa para registrar eventos de un DE.

Datos a enviar:

  • Requiere enviar los datos a emitir en la sección BODY de la petición HTTP.

  • Se debe enviar la estructura definida, y con esto se generará la petición, el dato debe ser enviado en formato JSON.

Respuesta:

  • Retorna una estructura JSON con la siguiente información:

Campo
Descripción

ok

Indica si la respuesta a la petición es correcta.

Ejemplo de respuesta en JSON:

{
  "ok": true
}

Evento:

El JSON enviado debe contener los siguientes campos:

Campo
Tipo
Requerido
Descripción

rol

Texto

Obligatorio

Indica el rol en el evento, puede ser "emisor" o "receptor".

evento

Número

Obligatorio

Número del evento correspondiente

cdc

Texto

Depende

Código del Documento, requerido para ciertos eventos.

motivo

Texto

Depende

Motivo del evento, requerido para ciertos eventos.

tipode

Número

Depende

Tipo de documento, requerido para la inutilización.

establec

Número

Depende

Establecimiento, requerido para la inutilización.

puntoexp

Número

Depende

Punto de expedición, requerido para la inutilización.

inicio

Número

Depende

Número inicial, requerido para la inutilización.

fin

Número

Depende

Número final, requerido para la inutilización.

conforme

Número

Depende

Estado de conformidad, requerido para la conformidad del DE.

recepcion

Fecha y hora

Depende

Fecha de recepción, requerido para ciertos eventos.

Ejemplo de envío en JSON:

Requisitos por Tipo de Evento

Emisor

  1. Cancelación (Evento 1)

    • cdc

    • motivo

  2. Inutilización (Evento 2)

    • motivo

    • tipode

    • establec

    • puntoexp

    • inicio

    • fin

Receptor

  1. Acuse de Recepción del DE (Evento 10)

    • cdc

    • recepcion

    • total

  2. Conformidad del DE (Evento 11)

    • cdc

    • conforme: (1 o 2)

    • recepcion: Requerido si conforme es 2

  3. Disconformidad del DE (Evento 12)

    • cdc

    • motivo

  4. Desconocimiento del DE (Evento 13)

    • cdc

    • motivo

Última actualización