Generar ficheros para crear y modificar eventos de calendario

A través de la API podremos generar archivos en formato ICS de creación y edición para su importación en gestores de correo electrónico y calendario como Microsoft Outlook, Google Calendar o Apple Calendar, entre otros.

La respuesta ofrece en ambos casos el identificador (uid) del evento (generado automáticamente en el caso de la creación), el fichero (fichero) en Base64 y el nombre sugerido por ServiciosCGES para el fichero.

Para la edición, será necesario enviar el identificador (uid) del evento que se desea modificar.

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #49cc90;background: rgba(73,204,144,.1);">
<div style="border-color: #49cc90;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #49cc90;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">POST</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/global/planificaciones/calendarios/fichero</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Generar fichero de calendario para planificaciones</div>
</div>
</div>

<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #fca130;background: rgba(252,161,48,.1);">
<div style="border-color: #fca130;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;">
<span style="background: #fca130;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">PUT</span>
<span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cges/global/planificaciones/calendarios/{uid}/fichero</span>
<div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Generar fichero de modificación de evento de calendario</div>
</div>
</div>

Personalización del evento

Elementos comunes

• Aunque sólo el titulo del evento es obligatorio, se recomienda informar una descripcion y ubicacion, que corresponden al contenido de la convocatoria y la ubicación donde va a producirse la misma.
• Es necesario indicar, en el atributo fechas, al menos la fecha de inicio del evento con su hora correspondiente. También se puede indicar una fecha de fin dentro del mismo día y con la hora de finalización informada.
• También está habiltada la posibilidad de añadir un organizador del evento y uno o varios asistentes.
• Se podrá indicar en el parámetro requerido si la asistencia del asistente a la convocatoria es requerida u opcional.
• Se recomienda informar los correos electrónicos de los organizadores y asistentes para que los gestores de calendario puedan notificar a través de correo los posibles cambios que puedan generar sobre el evento.
• Se podrá indicar los minutos previos a la convocatoria para mostrar una alerta (minutosAlarma) para aquellos gestores de calendario que soporten la funcionalidad.
• Se puede adjuntar un único fichero a la convocatoria como adjunto.
• Marque diaCompleto a true si el evento ocupa todo el día.

Crear eventos recurrentes

Es posible personalizar el evento indicando datos como la frecuencia de repetición si fuera necesario. También puede generar ficheros de modificación para modificar la recurrencia de un evento existente.

Para crear eventos que se repiten en el tiempo, debe hacer uso del atributo repeticion e indicar lo siguiente:

• La frecuencia del evento recurrente, que puede ser DIARIA, SEMANAL, MENSUAL o ANUAL.
• La configuración de periodicidad del evento:
  • El parámetro intervalo indica cada cuántas iteraciones debe contarse la recurrencia (una periodicidad semanal con intervalo = 3 guardará el evento cada 3 semanas).
  • Para una frecuencia SEMANAL, deberá indicar en el atributo semanal para qué días de la semana debe repetirse el evento (del 1 al 7, empezando por el lunes hasta el domingo).

  • Por ejemplo, para un evento semanal que se deba repetir todos los martes, jueves y viernes (desde la fecha de inicio a la fecha de fin indicadas), deberá enviar el atributo semanal=[2,4,5]

• • Para una frecuencia MENSUAL, deberá indicar en el atributo mensual alguno de los siguientes valores:
    • Si marca a true el parámetro diaDelMes, el evento se repetirá mensualmente el mismo día numérico que el de la fecha de inicio.
    • Si marca a true el parámetro diaDeLaSemana, el evento se repetirá mensualmente el mismo día de la semana relativo al mes de la fecha de inicio.
    • Si prefiere marcar una configuración relativa, deberá informar en el atributo relativo lo siguiente:
      • La posicion respecto al mes para indicar si es el último (-1), el primero (1), el segundo (2), el tercero (3) o el cuarto (4) día del mes a repetir.
      • El dia a repetir (del 1 al 7, empezando por el lunes hasta el domingo).

  • Ejemplos para un evento mensual generado con fecha de inicio 14 abr 2021 Día del mes: El evento se repetirá el día 14 de todos los meses a partir de la fecha de inicio indicada (y hasta la fecha de fin, si se informa). Día de la semana: El evento se repetirá el segundo miércoles de cada mes a partir de la fecha de inicio indicada (y hasta la fecha de fin, si se informa). Relativo: Si se envia posicion=-1 y dia=1, el evento se repetirá el último lunes de cada mes a partir de la fecha de inicio indicada (y hasta la fecha de fin, si se informa).

  • Para una frecuencia ANUAL, se deberá indicar en el atributo anual y en el parámetro relativo:
    • La posicion respecto al mes para indicar si es el último (-1), el primero (1), el segundo (2), el tercero (3) o el cuarto (4) día del mes a repetir.
    • El dia a repetir (del 1 al 7, empezando por el lunes hasta el domingo).
    • El mes en el que se repetirá. (del 1 al 12, empezando por enero).

  • Ejemplo para un evento anual generado con fecha de inicio 14 abr 2021 Relativo: Si se envia posicion=3, dia=2, mes=7 el evento se repetirá el tercer martes de julio a partir de la fecha de inicio indicada (y hasta la fecha de fin, si se informa).

• La configuración de finalizacion de la recurrencia permite lo siguiente:
  • Indicar una fecha de finalización de la recurrencia.
  • O, si lo prefiere, indicar el número de repeticiones que deben ejecutarse antes de finalizar.

Cancelación de eventos

En caso de querer cancelar un evento, deberá enviar en la modificación el atributo cancelar a true y el resto del cuerpo del mensaje debe llevar una configuración adecuada al último estado del evento (fechas, recurrencia, etc.)