Referencia de la API de REST de calendario de Outlook (versión 1.0)

Artículo
06/30/2018

Nota

La versión 1.0 de la API de REST de Outlook está obsoleta. A partir del 1 de noviembre de 2018, las aplicaciones ya no podrán utilizar la autentificación básica con el punto de conexión REST v1.0. El 1 de noviembre de 2019, el punto de conexión REST v1.0 se retirará completamente, y la documentación de la versión 1.0 se eliminará poco después. Comience a migrar su aplicación para utilizar la API de REST de Outlook en la versión 1.0 de Microsoft Graph. Vea más detalles en nuestro anuncio.

La API de calendario proporciona acceso a eventos, calendario y datos de grupos de calendario protegidos por Azure Active Directory en Office 365, y a datos similares en cuentas de Microsoft específicamente en estos dominios: Hotmail.com, Live.com, MSN.com, Outlook.com y Passport.com.

Nota

La excepción es la API para encontrar horas de reuniones, que se aplica solo a los buzones de Office 365 (en Azure AD) y no a las cuentas de Microsoft.
Para simplificar la referencia, en el resto de este artículo se utiliza Outlook.com para englobar a estos dominios de cuentas Microsoft.

¿No está interesado en la versión 1.0 de la API? En el índice de la izquierda, vaya a la sección Referencia de la API de REST de Office 365 y seleccione la versión que desee.

Todas las operaciones de la API de calendario

Operaciones de eventos

Un evento representa una cita o reunión en el calendario del usuario. Un evento puede ser un patrón de serie (para eventos periódicos), una repetición, una instancia única o una excepción.

Obtener eventos
Sincronizar eventos
Crear eventos
Actualizar eventos
Responder a eventos
Eliminar eventos
Obtener datos adjuntos
Crear adjuntos
Eliminar archivos adjuntos
Recibir recordatorios
Posponer recordatorios
Descartar recordatorios

Operaciones de calendario

Un calendario sirve como un contenedor de eventos. Un usuario puede tener varios calendarios. En Office 365, cada calendario se puede asignar a un grupo de calendarios.

Obtener calendarios
Crear calendarios
Actualizar calendarios
Eliminar calendarios

Operaciones de grupos de calendarios

Los grupos de calendarios son una forma de organizar varios calendarios. Los usuarios pueden agregar varios calendarios a un solo grupo de calendarios en Outlook o Outlook Web App. Esto permite a los usuarios ver más fácilmente y de forma rápida todos los calendarios del grupo.

Nota

Outlook.com solo admite el grupo de calendarios predeterminado al que se puede acceder mediante el acceso directo ../me/calendars. No se puede eliminar ese grupo de calendarios ni crear otro.

Obtener grupos de calendarios
Crear grupos de calendarios
Actualizar grupos de calendarios
Eliminar grupos de calendarios

Vea también

Uso de la API de REST de calendario

Autenticación

Como cualquier otra API REST de Outlook, para cada solicitud a la API de calendario de Outlook, debería incluir un token de acceso válido. Obtener un token de acceso requiere que haya registrado e identificado su aplicación y obtenido la autorización correspondiente.

Puede obtener más información sobre algunas opciones de registro y autorización optimizadas para usted. Tenga esto en cuenta a medida que avance con las operaciones específicas en la API de calendario.

Ámbitos para acceder a calendarios compartidos

Los calendarios de Office 365 y Outlook.com admiten el uso compartido. Un usuario que ha creado un calendario lo puede compartir con otros usuarios. Se requieren los siguientes ámbitos para acceder a un calendario que se ha compartido con ese usuario:

Para el acceso de lectura: https://outlook.office.com/calendars.read.shared
Para el acceso de lectura/escritura: https://outlook.office.com/calendars.readwrite.shared

Versión de la API

La API REST de calendario es compatible con todas las versiones de la API REST de Outlook. La funcionalidad puede variar según la versión específica.

Usuario objetivo

Las solicitudes de la API de calendario siempre se realizan en nombre del usuario actual.

Consulte Utilizar la API REST de Outlook para obtener más información común a todos los subconjuntos de la API REST de Outlook.

Obtener eventos

Obtener una colección de eventos o un evento.

Un cuerpo de evento puede estar en texto o HTML. Actualmente, esta operación GET devuelve los cuerpos de los eventos solo en formato HTML.

Obtener una vista de calendario
Obtenga patrones de series y eventos individuales
Obtener instancias de eventos)
Obtener un evento

Obtener una vista de calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtiene las repeticiones, excepciones e instancias únicas de eventos en una vista de calendario definida por un intervalo de tiempo del calendario principal del usuario (../me/calendarview) o de otro calendario.

GET https://outlook.office.com/api/v1.0/me/calendarview?start={start_datetime}&end={end_datetime}
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_id	cadena	El Id. del calendario, si desea obtener una vista de calendario de un calendario específico.
start_datetime	datetimeoffset	La fecha y la hora en la que comienza el evento.
end_datetime	datetimeoffset	La fecha y la hora en la que finaliza el evento.

Nota

De forma predeterminada, cada evento de la respuesta incluye todas sus propiedades. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Por ejemplo, obtenga la vista de calendario para el mes de octubre, de manera que se devuelva solo la propiedad Subject para cada evento:

GET https://outlook.office.com/api/v1.0/me/calendarview?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject

Tipo de respuesta

Los eventos expandidos en el intervalo de tiempo especificado.

Obtenga patrones de series y eventos individuales

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenga una colección de patrones de series y eventos de instancia única del calendario principal del usuario (../me/events) o de un calendario distinto. Para obtener instancias de eventos expandidas, puede obtener la vista de calendario o bien obtener las instancias de un evento.

GET https://outlook.office.com/api/v1.0/me/events
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_id	cadena	El Id. de calendario, si está recibiendo eventos de un calendario específico.

Nota

Cada evento de la respuesta incluye todas sus propiedades. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre. Vea el ejemplo siguiente. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

El siguiente ejemplo muestra cómo utilizar $select para especificar que se devuelvan solo las propiedades Subject, Organizer, Start y End de cada evento en la respuesta. Consulte la primera respuesta de ejemplo en Obtener un evento (REST) para acceder a una lista completa de las propiedades que se devolverían para un evento si no se utiliza $select.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/events?$select=Subject,Organizer,Start,End

Respuesta de ejemplo

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWw==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyDAAA=",
            "Subject": "Scrum",
            "Start": "2015-11-02T17:00:00Z",
            "End": "2015-11-02T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWg==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyCAAA=",
            "Subject": "team lunch",
            "Start": "2015-11-02T00:00:00Z",
            "End": "2015-11-03T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
            "Subject": "Weekly Meeting on Contoso Project",
            "Start": "2014-10-13T21:00:00Z",
            "End": "2014-10-13T22:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG92AAA=",
            "Subject": "Daily Team Meeting",
            "Start": "2014-10-13T18:00:00Z",
            "End": "2014-10-13T18:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x47Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG91AAA=",
            "Subject": "Rob:Alex 1:1",
            "Start": "2014-10-15T16:30:00Z",
            "End": "2014-10-15T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG90AAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2015-11-26T00:00:00Z",
            "End": "2015-11-27T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9zAAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2014-11-27T00:00:00Z",
            "End": "2014-11-28T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=",
            "Subject": "New Year's Day Holiday",
            "Start": "2015-01-01T00:00:00Z",
            "End": "2015-01-02T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x45w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9xAAA=",
            "Subject": "Christmas Holiday",
            "Start": "2014-12-25T00:00:00Z",
            "End": "2014-12-26T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        }
    ]
}

Obtener instancias de evento

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Puede obtener las instancias (repeticiones) de un evento para un intervalo de tiempo especificado. Si el evento es un tipo SeriesMaster, esto devuelve las repeticiones y excepciones del evento en el intervalo de tiempo especificado.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento.
start_datetime	datetimeoffset	La fecha y la hora UTC en la que comienza el evento.
end_datetime	datetimeoffset	La fecha y la hora UTC en la que finaliza el evento.

Tipo de respuesta

La colección de eventos solicitada.

Nota

Por ejemplo, obtener las instancias de un evento determinado para el mes de octubre, incluir solo las propiedades Subject, Start y End de cada instancia:

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEAAA=/instances?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject,Start,End

Obtener un evento

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtener un evento por Id.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	El Id. del evento.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=

Respuesta de ejemplo

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "DateTimeCreated": "2014-10-19T23:13:47.3959685Z",
    "DateTimeLastModified": "2014-10-23T20:23:47.0735997Z",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x49w==",
    "Categories": [],
    "StartTimeZone": "Pacific Standard Time",
    "EndTimeZone": "Pacific Standard Time",
    "ResponseStatus": {
        "Response": "Organizer",
        "Time": "0001-01-01T00:00:00Z"
    },
    "iCalUId": "040000008200E00074C5B7101A82E0080000000005F3F755F2EBCF010000000000000000100000007547017C91509D42A5B60C97141AA3DD",
    "Reminder": 15,
    "HasAttachments": false,
    "Subject": "Weekly Meeting on Contoso Project",
    "Body": {
        "ContentType": "HTML",
        "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nSetting up some time to review the budget and planning on the Contoso Project\r\n</body>\r\n</html>\r\n"
    },
    "BodyPreview": "Setting up some time to review the budget and planning on the Contoso Project",
    "Importance": "Normal",
    "Sensitivity": "Normal",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Location": {
        "DisplayName": "Alex's Office"
    },
    "IsAllDay": false,
    "IsCancelled": false,
    "IsOrganizer": true,
    "Recurrence": {
        "Pattern": {
            "Type": "Weekly",
            "Interval": 1,
            "Month": 0,
            "DayOfMonth": 0,
            "DaysOfWeek": [
                "Monday"
            ],
            "FirstDayOfWeek": "Sunday",
            "Index": "First"
        },
        "Range": {
            "Type": "NoEnd",
            "StartDate": "2014-10-13T00:00:00-07:00",
            "EndDate": "0001-01-01T00:00:00Z",
            "NumberOfOccurrences": 0
        }
    },
    "ResponseRequested": true,
    "SeriesMasterId": null,
    "ShowAs": "Busy",
    "Type": "SeriesMaster",
    "Attendees": [
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Janet Schorr",
                "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
            }
        },
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Pavel Bansky",
                "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
            }
        }
    ],
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }

Tipo de respuesta

El evento solicitado.

Nota

De forma predeterminada, la respuesta incluye todas las propiedades del evento. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre. Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

El siguiente ejemplo muestra cómo utilizar $select para especificar que se devuelvan solo las propiedades Subject, Organizer, Start y End de cada evento de la respuesta.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=?$select=Subject,Organizer,Start,End

Respuesta de ejemplo

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "Subject": "Weekly Meeting on Contoso Project",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }
}

Sincronizar eventos

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Sincronice y obtenga eventos nuevos, actualizados o eliminados en un intervalo de tiempo específico del calendario principal del usuario (../me/calendarview) o de un calendario distinto. Un conjunto de eventos de este tipo en un intervalo de tiempo también se conoce como una vista de calendario. Los eventos devueltos pueden incluir repeticiones y excepciones de una serie periódica e instancias únicas.

La sincronización de una vista de calendario generalmente requiere una ronda de dos o más solicitudes de sincronización, cada una de las cuales es una llamada GET. Para sincronizar una vista de calendario, utilice el método GET de la misma forma en que obtiene una vista de calendario, con la excepción de que debe incluir determinados encabezados de solicitud, y deltaToken o skipToken cuando corresponda.

Encabezados de solicitud

Debe especificar el encabezado "Prefer: odata.track-changes" en todas las solicitudes de sincronización, excepto aquellas que incluyen un skipToken que se devuelve de una solicitud de sincronización anterior. En la primera respuesta, busque el encabezado Preference-Applied: odata.track-changes para confirmar que el recurso admite la sincronización antes de continuar. (Más información sobre un skipToken en los datos de la segunda respuesta de ejemplo a continuación.)
Puede especificar el encabezado "Prefer: odata.maxpagesize = {x}" para indicar el número máximo de eventos que devuelve la solicitud de sincronización.

A continuación se muestra una ronda típica de eventos de sincronización en una vista de calendario:

Realice la solicitud GET inicial con el encabezado Prefer: odata.track-changes obligatorio. La respuesta inicial a una solicitud de sincronización siempre devuelve un deltaToken. (La segunda solicitud GET y las solicitudes posteriores difieren de la primera solicitud GET al incluir un deltaToken o un skipToken recibido en una respuesta anterior).
Si la primera respuesta devuelve el encabezado Preference-Applied: odata.track-changes, puede continuar con la sincronización.
- Haga una segunda solicitud GET. Especifque el encabezado Preferar: odata.track-changes y el deltaToken devuelto con el primer GET para determinar si hay mas eventos. La segunda solicitud devolverá eventos adicionales, y un skipToken si hay más eventos disponibles, o un deltaToken si se ha sincronizado el último evento, en cuyo caso puede detenerlo.
- Continúe la sincronización enviando una llamada GET e incluyendo un skipToken devuelto en la llamada anterior. Deténgase cuando obtenga una respuesta final que contenga un encabezado @odata.deltaLink con un deltaToken de nuevo, lo que indica que la sincronización se ha completado.

Eche un vistazo a la sintaxis de las llamadas iniciales y posteriores en una ronda de sincronización.

Para sincronizar el calendario predeterminado

Solicitud inicial:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Segunda solicitud, o primera solicitud de una ronda posterior:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

Tercera solicitud o solicitud posterior de la misma ronda:

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

Para sincronizar un calendario específico

Solicitud inicial:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Segunda solicitud, o primera solicitud de una ronda posterior:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

Tercera solicitud o solicitud posterior de la misma ronda:

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

Parámetros

Parámetro	Tipo	Descripción
Parámetros de dirección URL
user_context	cadena	El contexto del usuario. Puede utilizar el valor de 'me' para indicar el contexto del usuario actual. También puede utilizar el formato users / {upn} donde upn es el nombre principal del usuario que generalmente es la dirección de correo electrónico del usuario.
calendar_id	cadena	El Id. del calendario, si desea obtener una vista de calendario de un calendario específico.
start_datetime	datetimeoffset	La fecha y la hora en la que comienza el evento.
end_datetime	datetimeoffset	La fecha y hora en que finaliza el evento.
delta_token	cadena	La cadena `deltaToken` devuelta como parte del valor de @odata.deltaLink en la respuesta de sincronización anterior.
skip_token	cadena	La cadena `skipToken` devuelta como parte del valor de @data.nextLink en la respuesta de sincronización anterior.

Nota

Al especificar "Prefer: odata.track-changes" en la solicitud inicial, si la respuesta admite la sincronización, la respuesta incluirá el encabezado "Preference-applied: odata.track-changes".
Si intenta sincronizar un recurso que no es compatible, o si esta no es la solicitud de sincronización inicial, no verá el encabezado "Preference-applied" en la respuesta.
Puede modificar la ventana de tiempo de cambio cambiando los parámetros de consulta startdatetime y enddatetime.
Cada evento en la respuesta incluye todas sus propiedades.
Para una serie periódica, una respuesta de sincronización incluye todo el evento para eventos de excepción y de patrón periódicos.
Las instancias de una serie periódica se abrevian y contienen solo las propiedades Start y End. Puede capturar el resto de la información del evento de repetición del evento de patrón periódico. Consulte en Recurso de evento la información de referencia.
No se pueden usar los parámetros de consulta $filter, $count, $select, $skip, $top ni $search.

Tipo de respuesta

Los eventos expandidos y los eventos abreviados en el intervalo de tiempo especificado.

Ejemplo

El siguiente ejemplo muestra la solicitud de sincronización inicial y la segunda solicitud de sincronización para sincronizar el calendario predeterminado del usuario. Cada solicitud especifica devolver solo un evento completo cada vez:

La respuesta inicial devuelve un evento, un deltaLink y deltaToken.
La segunda solicitud utiliza ese deltatoken. La segunda respuesta devuelve un evento, un nextLink y skipToken.

Para completar la sincronización, utilice el skipToken devuelto con la solicitud de sincronización anterior hasta que la respuesta de sincronización devuelva un deltaLink y deltaToken, en cuyo caso esta ronda de sincronización se ha completado. Guarde el deltaToken para la próxima ronda de sincronización.

Para obtener más información, consulte Sincronizar eventos en una vista de calendario de Outlook.

Solicitud inicial de ejemplo

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z HTTP/1.1
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

Datos de ejemplo de respuesta inicial

Preference-Applied: odata.track-changes

    {
        "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView",
        "value": [
            {
                "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('asdas==')",
                "@odata.etag": "W/\"L8Z+4Y4u7k+97uRKg==\"",
                "Id": "AQMkANJAAAAA==",
                "ChangeKey": "L8Z+AAAAARKg==",
                "Categories": [
                ],
                "DateTimeCreated": "2015-04-10T17:54:49.2725912Z",
                "DateTimeLastModified": "2015-04-10T17:54:49.3038538Z",
                "Subject": "Discuss the Calendar REST API",
                "BodyPreview": "I think it will meet our requirements!",
                "Body": {
                    "ContentType": "HTML",
                    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
                },
                "Importance": "Normal",
                "HasAttachments": false,
                "Start": "2015-04-05T18:00:00Z",
                "StartTimeZone": "Pacific Standard Time",
                "End": "2015-04-05T19:00:00Z",
                "EndTimeZone": "Pacific Standard Time",
                "Reminder": 15,
                "Location": {
                    "DisplayName": "",
                    "Address": null
                },
                "ResponseStatus": {
                    "Response": "Organizer",
                    "Time": "0001-01-01T00:00:00Z"
                },
                "ShowAs": "Busy",
                "IsAllDay": false,
                "IsCancelled": false,
                "IsOrganizer": true,
                "ResponseRequested": true,
                "Type": "SingleInstance",
                "SeriesMasterId": null,
                "Attendees": [
                ],
                "Recurrence": null,
                "Organizer": {
                    "EmailAddress": {
                        "Address": "user0@contoso.com",
                        "Name": "user0"
                    }
                },
                "iCalUId": "040000008200E9888E07599CCFA23",
                "WebLink": "https://outlook.office.com/owa/?ItemID=AAAINJAAAAA%3D%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
            }
        ],
        "@odata.deltaLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-04-10T00%3a00%3a00Z&%24deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c"
    }

Segunda solicitud de ejemplo

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z&$deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

Datos de ejemplo de segunda respuesta

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView/$delta",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('AAMkAD0jAAA=')",
            "@odata.etag": "W/\"P2fd7QAAAAAVFA==\"",
            "Id": "AAMkADNkNmVlOTITVAAAAAA0jAAA=",
            "ChangeKey": "P2fdmIU1QAAAAAVFA==",
            "Categories": [
            ],
            "DateTimeCreated": "2015-04-15T18:59:11.0226221Z",
            "DateTimeLastModified": "2015-04-15T18:59:11.0694979Z",
            "Subject": "1 hour",
            "BodyPreview": "\u200b",
            "Body": {
                "ContentType": "HTML",
                "Content": "<html><body>content</body></html>"
            },
            "Importance": "Normal",
            "HasAttachments": false,
            "Start": "2015-04-16T18:00:00Z",
            "StartTimeZone": "Pacific Standard Time",
            "End": "2015-04-16T19:00:00Z",
            "EndTimeZone": "Pacific Standard Time",
            "Reminder": 15,
            "Location": {
                "DisplayName": "",
                "Address": {
                    "Street": "",
                    "City": "",
                    "State": "",
                    "CountryOrRegion": "",
                    "PostalCode": ""
                }
            },
            "ResponseStatus": {
                "Response": "Organizer",
                "Time": "0001-01-01T00:00:00Z"
            },
            "ShowAs": "Busy",
            "IsAllDay": false,
            "IsCancelled": false,
            "IsOrganizer": true,
            "ResponseRequested": true,
            "Type": "SingleInstance",
            "SeriesMasterId": null,
            "Attendees": [
            ],
            "Recurrence": null,
            "Organizer": {
                "EmailAddress": {
                    "Address": "user0@contoso.com",
                    "Name": "user0"
                }
            },
            "iCalUId": "040000008200E09BB89A316862",
            "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADNkNmVlOAA%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
        }
    ],
    "@odata.nextLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-08-10T00%3a00%3a00Z&%24skipToken=530c9d02ae1a4d96804538bd4d381546"
}

Buscar horarios de reuniones

Esta característica está actualmente disponible en las versiones v2.0 y beta.

Obtener salas de reuniones (versión preliminar)

Esta característica está actualmente disponible solo en la versión beta.

Crear eventos

Crear un evento de calendario

Crear un evento de calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cree un evento en el calendario principal del usuario o en un calendario específico al publicar en el punto de conexión events del calendario. Cuando se crea el evento, el servidor envía invitaciones a todos los asistentes.

De forma predeterminada, los valores de hora de Inicio y Finalización están en UTC. Puede especificar zonas horarias para Startx y End, expresar la hora en la zona horaria correspondiente e incluir una compensación de tiempo de UTC.

El siguiente ejemplo muestra cómo asignar valores de hora en Hora estándar del Pacífico. Tenga en cuenta que si especifica una zona horaria, también debe especificar un valor para la otra.

POST https://outlook.office.com/api/v1.0/me/events
POST https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_id	cadena	El identificador del calendario.

Solicitud de ejemplo

POST https://outlook.office.com/api/v1.0/me/events

Content-Type: application/json

{
  "Subject": "Discuss the Calendar REST API",
  "Body": {
    "ContentType": "HTML",
    "Content": "I think it will meet our requirements!"
  },
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Type": "Required"
    }
  ]
}

Respuesta de ejemplo

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1RAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:56:10.1058291Z",
  "DateTimeLastModified": "2014-01-22T20:56:10.3402186Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": ""
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Status": {
        "Response": "None",
        "Time": "0001-01-01T00:00:00Z"
      },
      "Type": "Required"
    }
  ],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

Tipo de respuesta

El nuevo evento.

De forma predeterminada, la respuesta incluye todas las propiedades del nuevo evento. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre.

El siguiente es un ejemplo para incluir solo las propiedades Start y End del nuevo evento en la respuesta.

POST https://outlook.office.com/api/v1.0/me/events?$Select=Start,End

Actualizar eventos

Actualizar un evento de calendario

Actualizar un evento de calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cambiar un evento Solo se modifican las propiedades que especifique. Si el usuario es el organizador, el servidor envía las actualizaciones de la reunión a todos los asistentes.

PATCH https://outlook.office.com/api/v1.0/me/events/{event_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento.

Especifique cualquier propiedad event editable en el cuerpo de la solicitud.

Solicitud de ejemplo

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=

Content-Type: application/json

{
  "Location": {
    "DisplayName": "Your office"
  }
}

Respuesta de ejemplo

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:49:05.5657528Z",
  "DateTimeLastModified": "2014-01-22T21:14:17.4886416Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": "Your office"
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

Tipo de respuesta

El evento actualizado. Si el usuario es el organizador, el servidor envía las actualizaciones de la reunión a todos los asistentes.

De forma predeterminada, la respuesta incluye todas las propiedades del evento actualizado. Utilice $select para especificar solo las propiedades que necesita para un mejor rendimiento. La propiedad Id se devuelve siempre.

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE1MFKPQWAAA=?$select=Location

Aceptar evento

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Acepta el evento especificado.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/accept

Parámetro	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento. Obligatorio.
Parámetros de cuerpo
Comment	cadena	Texto incluido en la respuesta. Opcional.
SendResponse	booleano	`true` si se va a enviar una respuesta al organizador; de lo contrario, `false`. Opcional. El valor predeterminado es `true`.

Solicitud de ejemplo

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/accept

Content-Type: application/json

{
  "Comment": "Great idea!",
  "SendResponse": "true"
}

Respuesta

Una respuesta correcta se indica mediante un código de respuesta HTTP 202 Aceptada.

Aceptar evento provisionalmente

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Acepta provisionalmente el evento especificado.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/tentativelyaccept

Parámetro	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento. Obligatorio.
Parámetros de cuerpo
Comentario	cadena	Texto incluido en la respuesta. Opcional.
SendResponse	booleano	`true` si se va a enviar una respuesta al organizador; de lo contrario, `false`. Opcional. El valor predeterminado es `true`.

Solicitud de ejemplo

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/tentativelyaccept

Content-Type: application/json

{
  "Comment": "I'll confirm later!",
  "SendResponse": "true"
}

Respuesta

Una respuesta correcta se indica mediante un código de respuesta HTTP 202 Aceptada.

Rechazar evento

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Rechaza la invitación al evento especificado.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/decline

Parámetro	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento. Obligatorio.
Parámetros de cuerpo
Comentario	cadena	Texto incluido en la respuesta. Opcional.
SendResponse	booleano	`true` si se va a enviar una respuesta al organizador; de lo contrario, `false`. Opcional. El valor predeterminado es `true`.

Solicitud de ejemplo

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/decline

Content-Type: application/json

{
  "Comment": "Sorry, maybe next time!",
  "SendResponse": "true"
}

Respuesta

Una respuesta correcta se indica mediante un código de respuesta HTTP 202 Aceptada.

Reenviar eventos (versión preliminar)

Esta característica está actualmente disponible solo en la versión beta.

Eliminar eventos

Eliminar un evento del calendario

Eliminar un evento del calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Mover un evento a la carpeta Elementos eliminados del usuario que ha iniciado sesión. Si el evento es una reunión y el usuario que ha iniciado sesión es el organizador, el servidor envía cancelaciones a todos los asistentes.

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	El Id. del evento.

Solicitud de ejemplo

DELETE https://outlook.office.com/api/v1.0/me/events/AAMkAGE0M4v1OAAA=

Respuesta de ejemplo

Status code: 204

Cancelar eventos (versión preliminar)

Esta característica está actualmente disponible solo en la versión beta.

Obtener datos adjuntos

Puede obtener datos adjuntos o una colección de datos adjuntos.

Obtener una colección de datos adjuntos
Obtener datos adjuntos

Obtener una colección de datos adjuntos

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtiene los datos adjuntos de un evento determinado.

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	El Id. del evento.

Tipo de respuesta

Una colección de datos adjuntos que puede ser del tipo FileAttachment o ItemAttachment.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments

Respuesta de ejemplo

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments",
    "value": [
        {
            "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2NGTG9yAAA=')/Attachments('AAMkAGI2NGLwydGuOzcHf1FBlo=')",
            "Id": "AAMkAGI2NGLwydGuOzcHf1FBlo=",
            "DateTimeLastModified": "2014-10-22T00:30:26Z",
            "Name": "Company Party.docx",
            "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "Size": 11647,
            "IsInline": false,
            "ContentId": null,
            "ContentLocation": null,
            "ContentBytes": "UEsDBBQABgAIAAAAIQDfpNJs...AAF4pAAAAAA=="
            "IsContactPhoto": false
        }
    ]
}

Obtener datos adjuntos

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Recibir datos adjuntos de un evento determinado.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento.
attachment_id	cadena	El identificador de los datos adjuntos.

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Tipo de respuesta

El archivo adjunto o elemento adjunto solicitado.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=

Respuesta de ejemplo

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments/$entity",
    "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2WRAAADTG9yAAA=')/Attachments('AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=')",
    "Id": "AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo="
    "DateTimeLastModified": "2014-10-22T00:30:26Z",
    "Name": "Company Party.docx",
    "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "Size": 11647,
    "IsInline": false,
    "ContentId": null,
    "ContentLocation": null,
    "ContentBytes": "UEsDBBQABgAIAAAAIQD...AAF4pAAAAAA==",
    "IsContactPhoto": false
}

Crear adjuntos

Puede crear un archivo adjunto o un elemento adjunto para un evento.

Crear un archivo adjunto
Crear un elemento adjunto
Crear una referencia adjunta

Crear un archivo adjunto

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Agregue un archivo adjunto a un evento.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento.
Parámetros de cuerpo
@odata.type	cadena	#Microsoft.OutlookServices.FileAttachment
Name	cadena	El nombre de los datos adjuntos.
ContentBytes	binario	El archivo que se va a adjuntar.

Tipo de respuesta

El nuevo archivo adjunto.

Crear un elemento adjunto

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Agregue un elemento adjunto a un evento.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento.
Parámetros de cuerpo
@odata.type	cadena	# Microsoft.OutlookServices.ItemAttachment
Name	cadena	El nombre de los datos adjuntos.
Elemento	Una entidad Mensaje, Evento o Contacto.	El elemento que se va a adjuntar.

Tipo de respuesta

El nuevo elemento adjunto.

Crear una referencia adjunta

Ámbito mínimo necesario

https://outlook.office.com/calendars.readwrite

Agregue una referencia adjunta a un evento.

Esta característica está actualmente disponible solo en la versión beta.

Eliminar archivos adjuntos

Eliminar un archivo adjunto de evento

Eliminar un archivo adjunto de evento

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Elimine el archivo adjunto especificado de un evento. El archivo adjunto puede ser un archivo adjunto o elemento adjunto.

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
event_id	cadena	Id. de evento.
attachment_id	cadena	El identificador de los datos adjuntos.

Solicitud de ejemplo

DELETE https:/outlook.office.com/api/v1.0/me/events/AAMkAGE0MG4v1OAAA=/attachments/AAMkAGITG9yAAA=

Respuesta de ejemplo

Status code: 204

Recibir recordatorios

Reciba una lista de los recordatorios de eventos entre dos fechas y horas de un calendario.

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Esta característica está actualmente disponible en las versiones v2.0 y beta.

Posponer recordatorios

Posponga un recordatorio para atrasar el recordatorio hasta un nuevo horario.

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Esta característica está actualmente disponible en las versiones v2.0 y beta.

Descartar recordatorios

Descarta un recordatorio que se ha desencadenado.

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Esta característica está actualmente disponible en las versiones v2.0 y beta.

Obtener calendarios

Puede obtener un calendario o una colección de calendarios.

Obtener una colección de calendarios
Obtener un calendario

Obtener una colección de calendarios

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenga todos los calendarios del usuario (calendars) o los calendarios de un grupo de calendarios específico.

GET https://outlook.office.com/api/v1.0/me/calendars
GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calender_group_id	cadena	El identificador del grupo de calendarios.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/calendars

Respuesta de ejemplo

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
            "Name": "Calendar",
            "Color": "Auto",
            "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
        }
    ]
}

Tipo de respuesta

La colección de calendarios solicitada.

Obtener un calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenga un calendario por identificador. Puede obtener el calendario principal del usuario mediante el punto de conexión ../me/calendar.

GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_id	cadena	El identificador del calendario.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/calendars/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=

Respuesta de ejemplo

Código de estado: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
    "Name": "Calendar",
    "Color": "Auto",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
}

Tipo de respuesta

El calendario solicitado.

Crear calendarios

Crear un calendario

Crear un calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cree un calendario en el grupo de calendarios predeterminado usando el acceso directo ../me/calendars, o en un grupo de calendarios determinado publicando en el extremo calendars del grupo.

POST https://outlook.office.com/api/v1.0/me/calendars
POST https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calender_group_id	cadena	El Id. del grupo de calendarios, si obtiene calendarios de un grupo específico.
Parámetros de cuerpo
Name	cadena	El nombre del nuevo calendario.

Solicitud de ejemplo

POST https://outlook.office.com/api/v1.0/me/calendars

Content-Type: application/json

{
  "Name": "Social"
}

Respuesta de ejemplo

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLHAAA=",
  "Name": "Social",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ=="
}

Tipo de respuesta

El nuevo calendario.

Actualizar calendarios

Actualizar un calendario

Actualizar un calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cambie las propiedades grabables de un calendario.

PATCH https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_id	cadena	Id. de calendario
Parámetros de cuerpo
Name	cadena	El nuevo nombre del calendario.

Solicitud de ejemplo

PATCH https://outlook.office.com/api/v1.0/me/calendars/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=

Content-Type: application/json

{
  "Name": "Social events"
}

Respuesta de ejemplo

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=",
  "Name": "Social events",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw=="

Tipo de respuesta

El calendario actualizado.

Eliminar calendarios

Eliminar un calendario

Eliminar un calendario

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_id	cadena	El identificador del calendario.

Solicitud de ejemplo

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Respuesta de ejemplo

Status code: 204

Obtener grupos de calendarios

Puede obtener un grupo de calendarios o una colección de grupos de calendarios.

Obtener una colección de grupos de calendarios
Obtener un grupo de calendarios

Nota

Outlook.com solo admite el grupo de calendarios predeterminado al que se puede acceder mediante el acceso directo ../me/calendars.

Obtener una colección de grupos de calendarios

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenga los grupos de calendarios en un buzón.

GET https://outlook.office.com/api/v1.0/me/calendargroups

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/calendargroups

Respuesta de ejemplo

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
      "Name": "My Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==",
      "ClassId": "0006f0b7-0000-0000-c000-000000000046"
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuMAAA=",
      "Name": "Other Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==",
      "ClassId": "0006f0b8-0000-0000-c000-000000000046"
    }
  ]
}

Tipo de respuesta

La colección de grupos de calendarios solicitada.

Obtener un grupo de calendarios

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenga un grupo de calendarios por ID.

GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Nota

Consulte en Parámetros de consulta de OData los parámetros de filtrado, clasificación y paginación.

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_group_id	cadena	El identificador del grupo de calendarios.

Solicitud de ejemplo

GET https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=

Respuesta de ejemplo

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
    "Name": "My Calendars",
    "ClassId": "0006f0b7-0000-0000-c000-000000000046",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g=="
}

Tipo de respuesta

El grupo de calendarios solicitado.

Crear grupos de calendarios

Crear un grupo de calendarios. Name es la única propiedad editable para un grupo de calendarios.

Crear un grupo de calendarios

Nota

Outlook.com solo admite el grupo de calendarios predeterminado al que se puede acceder mediante el acceso directo ../me/calendars. No puede crear otro grupo de calendarios en Outlook.com.

Crear un grupo de calendarios

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

POST https://outlook.office.com/api/v1.0/me/calendargroups

Parámetro obligatorio	Tipo	Descripción
Parámetro URL
Parámetros de cuerpo
Name	cadena	El nombre del grupo de calendarios.

POST https://outlook.office.com/api/v1.0/me/calendargroups

Content-Type: application/json

{
  "Name": "Birthdays"
}

Respuesta de ejemplo

Código de estado: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Birthdays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

Tipo de respuesta

El nuevo grupo de calendarios.

Actualizar grupos de calendarios

Actualizar un grupo de calendarios

Actualizar un grupo de calendarios

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cambie el nombre de un grupo de calendarios. Name es la única propiedad grabable de grupo de calendarios.

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_group_id	cadena	Id. del grupo de calendarios.
Parámetros de cuerpo
Name	cadena	El nombre del grupo de calendarios actualizado.

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=

{
  "Name": "Holidays"
}

Respuesta de ejemplo

Código de estado: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Holidays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

Tipo de respuesta

El grupo de calendarios actualizado.

Eliminar grupos de calendarios

Eliminar un grupo de calendarios

Nota

Outlook.com solo admite el grupo de calendarios predeterminado al que se puede acceder mediante el acceso directo ../me/calendars. No elimine este grupo de calendarios.

Eliminar un grupo de calendarios

Ámbito mínimo necesario

Uno de los siguientes:

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Parámetro obligatorio	Tipo	Descripción
Parámetros de dirección URL
calendar_group_id	cadena	El identificador del grupo de calendarios.

Solicitud de ejemplo

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM4xLGAAA=

Respuesta de ejemplo

Status code: 204

Pasos siguientes

Tanto si está listo para empezar a compilar una aplicación como si simplemente desea obtener más información, tenemos todo lo que necesita.

Empezar a trabajar con las API de REST de correo, calendario y contactos.
¿Desea ver ejemplos? Los tenemos.

O bien, obtenga más información sobre el uso de la plataforma de Office 365:

Compartir a través de

Referencia de la API de REST de calendario de Outlook (versión 1.0)

Todas las operaciones de la API de calendario

Operaciones de eventos

Operaciones de calendario

Operaciones de grupos de calendarios

Vea también

Uso de la API de REST de calendario

Autenticación

Ámbitos para acceder a calendarios compartidos

Versión de la API

Usuario objetivo

Obtener eventos

Obtener una vista de calendario

Ámbito mínimo necesario

Tipo de respuesta

Obtenga patrones de series y eventos individuales

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta de ejemplo

Obtener instancias de evento

Ámbito mínimo necesario

Tipo de respuesta

Obtener un evento

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta de ejemplo

Tipo de respuesta

Solicitud de ejemplo

Respuesta de ejemplo

Sincronizar eventos

Ámbito mínimo necesario

Encabezados de solicitud

Para sincronizar el calendario predeterminado

Para sincronizar un calendario específico

Parámetros

Tipo de respuesta

Ejemplo

Buscar horarios de reuniones

Obtener salas de reuniones (versión preliminar)

Crear eventos

Crear un evento de calendario

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta de ejemplo

Tipo de respuesta

Actualizar eventos

Actualizar un evento de calendario

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta de ejemplo

Tipo de respuesta

Responder a eventos

Aceptar evento

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta

Aceptar evento provisionalmente

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta

Rechazar evento

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta

Reenviar eventos (versión preliminar)

Eliminar eventos

Eliminar un evento del calendario

Ámbito mínimo necesario

Solicitud de ejemplo

Respuesta de ejemplo

Cancelar eventos (versión preliminar)

Obtener datos adjuntos

Obtener una colección de datos adjuntos

Ámbito mínimo necesario

Tipo de respuesta

Solicitud de ejemplo

Respuesta de ejemplo

Obtener datos adjuntos

Ámbito mínimo necesario