Manual del integrador. Ejemplos de uso de webforms en Sede-e

Se listan a continuación los casos de uso más típicos. Puede obtener más información consultando el manual del desarrollador, incluyendo qué tipo de parámetros puede recibir cada método.

CASO 01. Carga de un formulario en formato HTML sin datos cumplimentados

Descripción:

Esta invocación permite que el usuario obtenga un HTML del formulario completamente en blanco.

Ejemplo de uso:

Puede ser útil si en la Sede-e se quiere ofrecer a un usuario sin autenticar el formulario en versión papel para que lo rellenen en el HTML y posteriormente lo impriman para presentarlo en el registro presencial.

Se puede ver un ejemplo de uso en la siguiente página cuando se pulsa sobre el botón de "Formulario en versión papel": https://sede.elhierro.es/sede/es/tramites-y-servicios/item/2012-solicitud-general

Código de ejemplo:

ejemplo-cargar-formulario-sin-datos

CASO 01.01. Carga de un formulario en formato HTML sin datos cumplimentados, donde el formulario se elige desde la URL

Descripción:: Esta invocación permite que el usuario obtenga un HTML del formulario completamente en blanco.
Ejemplo de uso:: Puede ser útil si en la Sede-e se quiere ofrecer a un usuario sin autenticar el formulario en versión papel para que lo rellenen en el HTML y posteriormente lo impriman para presentarlo en el registro presencial. Es como el caso 01, sólo que aquí se lee desde la URL
Código de ejemplo:: ejemplo-cargar-formulario-sin-datos-desde-url.html?formulario=ejemplo-integracion

CASO 02. Descargar un pdf en blanco del formulario

Descripción:: Esta invocación permite obtener el formulario en PDF con todos sus campos en blanco.
Ejemplo de uso:: Puede ser útil cuando se desea que el usuario pueda descargar desde la Sede-e una versión en papel del formulario.
Código de ejemplo:: ejemplo-descargar-pdf-blanco

CASO 03. Descargar un pdf en blanco del formulario con parámetros precargados

Descripción:: Esta invocación permite especificar parámetros del formulario que serán empleados a la hora de generar la versión pdf de un formulario en blanco.
Ejemplo de uso:: Puede ser útil cuando se desea que el usuario pueda descargar desde la Sede-e una versión en papel del formulario y algunos de los elementos del formulario dependen de parámetros.
Código de ejemplo:: ejemplo-descargar-pdf-blanco-con-parametros-precargados

CASO 04. Edición de un formulario con datos precargados

Descripción:: Esta invocación será la que se deba usar desde la Sede-e cuando en el Área personal se quiera comenzar la cumplimentación de un formulario.
Ejemplo de uso:: Será útil en el momento en el que se desee rellenar el formulario por primera vez precargándole determinados datos, por ejemplo los datos del solicitante.
Código de ejemplo:: ejemplo-cargar-formulario-con-datos-precargados

CASO 05. Edición de un formulario partiendo de un borrador existente

Descripción:: Esta invocación será la que se deba usar desde la Sede-e cuando en el Área personal se quiera editar un borrador existente.
Ejemplo de uso:: Será útil cuando se quiera continuar con la cumplimentación de un formulario para el que ya la Sede-e tenía un borrador. Su funcionamiento es idéntico al descrito en el CASO 03 pero en lugar de pasar un jsonData con los datos precargados se pasa el jsonData que se guardó la anterior vez que se editó el formulario (el borrador).
Código de ejemplo:: ejemplo-cargar-formulario-con-un-borrador

CASO 06. Edición de un formulario partiendo de un borrador correspondiente a una versión antigua

Descripción:: Esta invocación será la que se deba usar desde la Sede-e cuando en el Área personal se quiera editar un borrador existente.
Ejemplo de uso:: Será útil cuando se quiera continuar con la cumplimentación de un formulario para el que la Sede-e ya tenía un borrador, pese a que este haga referencia a una versión antigua del mismo. Su funcionamiento es idéntico al descrito en el CASO 04, pero en este caso al cargar el formulario se mostrará un mensaje indicando que el borrador no se corresponde con la última versión publicada y tratará de hacer corresponder los datos cargados con los campos de la última versión.
Código de ejemplo:: ejemplo-cargar-formulario-con-un-borrador-de-version-previa

CASO 07. Obtener un PDF de un formulario con datos precargados

Descripción:: Permite obtener una versión en PDF de un formulario con datos cumplimentados.
Ejemplo de uso:: Esta invocación será útil cuando se quiera consolidar un formulario y obtener el PDF definitivo con sus datos cumplimentados.
Código de ejemplo:: ejemplo-descargar-pdf-con-datos-precargados

CASO 08. Vista de un formulario HTML con datos precargados sin posibilidad de edición

Descripción:: Permite obtener una visualización en HTML de un formulario con sus datos precargados pero sin posibilidad de modificar los datos existentes.
Ejemplo de uso:: Esta invocación puede ser de utilidad si desde la Sede-e se desea que los formularios que ya han sido consolidados se puedan ver en HTML además de en PDF.
Código de ejemplo:: ejemplo-cargar-formulario-solo-lectura

CASO 09. Carga de un formulario en formato HTML con botones implementados por el integrador

Descripción:: El visualizador permite añadir botones adicionales donde la acción a realizar está implementada a medida por el integrador.
Ejemplo de uso:: Esta invocación puede ser de utilidad si desde la Sede-e se desea que los formularios ejecuten alguna acción distinta de las predefinidas por el visualizador.
Código de ejemplo:: ejemplo-cargar-formulario-con-botones-adicionales

CASO 10. Obtener un XML de un formulario con datos precargados

Descripción:: Permite obtener una versión en XML de un formulario con datos cumplimentados.
Ejemplo de uso:: Esta invocación será útil cuando se quiera obtener la versión en XML de los datos de un formulario cumplimentado.
Código de ejemplo:: ejemplo-descargar-xml-con-datos-precargados

CASO 11. Gestión de errores durante la visualización

Descripción:: Ejemplo de gestión de errores durante la visualización.
Ejemplo de uso:: Esta invocación será útil cuando se quiera reaaccionar a un checkIntegrity fallido.
Código de ejemplo:: ejemplo-gestion-errores

CASO 12. Obtener un PDF de un formulario con datos precargados con un XFA incrustado

Descripción:: Permite obtener una versión en PDF de un formulario con datos cumplimentados con un XFA incrustado.
Ejemplo de uso:: Esta invocación nos permitirá consolidar un formulario y obtener el PDF definitivo con sus datos cumplimentados y un XFA incrustado. Sirve principalmente como ejemplo y documentación de cómo pedir a la API un PDF con XFA incrustado, ya que al sólo ser extraible mediante herramientas que extraigan el XFA del pdf, no es muy útil que los usuarios finales tengan acceso al mismo
Código de ejemplo:: ejemplo-descargar-pdf-con-datos-precargados