Puede ser que por motivos del contrato acordado con cada proveedor no todos los apartados de esta página apliquen y carezca de permisos para ejecutar alguno de ellos.
Para más información, consulte antes el contrato asociado a su caso y defina con la STIC las funcionalidades adicionales que necesite.
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.
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. También se puede indicar una fecha de fin.
- 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.
Crear eventos recurrentes
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:
- 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 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:
Dia del mes: Si genera el evento con fecha de inicio , el evento se repetirá el día 14 de todos los meses a partir de la fecha indicada.
Dia de la semana:
- Para una frecuencia MENSUAL, deberá indicar en el atributo mensual alguno de los siguientes valores:
Es posible personalizar el evento indicando datos como la frecuencia de repetición si fuera necesario, los minutos para el aviso previo o alarma, entre otros.
En caso de querer cancelarlo, será necesario enviar el atributo cancelar a TRUE. El cuerpo del mensaje recibirá la misma configuración con la que fue generado el ICS de creación del evento.