Outlook-Kalender REST-API-Verweis (Version 1.0)
Gilt für: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Hinweis
Version 1.0 der Outlook REST-API ist veraltet. Ab dem 1. November 2018 können Apps die Standardauthentifizierung nicht mehr mit dem REST-Endpunkt v1.0 verwenden. Ab dem 1. November 2019 wird der v1.0 REST-Endpunkt vollständig stillgelegt und die v1.0-Dokumentation kurz darauf entfernt. Starten Sie die Migration Ihrer App zur Verwendung der Outlook REST-API in v1.0 von Microsoft Graph. Weitere Details finden Sie in unserer Ankündigung.
Die Kalender-API bietet Zugriff auf Ereignisse, Kalender und Kalendergruppendaten, die durch Azure Active Directory auf Office 365 gesichert sind, sowie auf ähnliche Daten in Microsoft-Konten speziell in diesen Domänen: Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com.
Hinweis
- Die Ausnahme ist die API zu Besprechungszeiten finden, die nur für Office 365-Postfächer (auf Azure AD) und nicht für Microsoft-Konten gilt.
- Zur Vereinfachung des Verweises verwendet der Rest dieses Artikels Outlook.com, um diese Microsoft-Kontodomänen aufzunehmen.
Kein Interesse an v1.0 der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zu Office 365 REST API reference und wählen Sie die gewünschte Version aus.
Alle Kalender-API-Operationen
Ereignisvorgänge
Ein Ereignis stellt einen Termin oder eine Besprechung im Kalender des Benutzers dar. Ein Ereignis kann ein Serienmaster (für wiederkehrende Ereignisse), ein Ereignis, eine einzelne Instanz oder eine Ausnahme sein.
- Ereignisse abrufen
- Ereignisse synchronisieren
- Ereignisse erstellen
- Ereignisse aktualisieren
- Auf Ereignisse antworten
- Ereignisse löschen
- Anlagen abrufen
- Anlagen erstellen
- Anlagen löschen
- Erinnerungen abrufen
- Erinnerungen „schlummern“ lassen
- Erinnerungen zurückweisen
Kalender-Vorgänge
Ein Kalender dient als Container für Ereignisse. Ein Benutzer kann mehrere Kalender haben. In Office 365 kann jeder Kalender einer Kalendergruppe zugeordnet werden.
Kalendergruppen-Vorgänge
Kalendergruppen bieten eine Möglichkeit, mehrere Kalender zu organisieren. Benutzer können mehrere Kalender zu einer einzigen Kalendergruppe in Outlook oder Outlook Web-App hinzufügen. Dies erleichtert den Benutzern die schnelle Anzeige aller Kalender innerhalb der Gruppe.
Hinweis
Outlook.com unterstützt nur die Standardkalendergruppe, die über die Verknüpfung ../me/calendars
erreichbar ist. Sie können diese Kalendergruppe nicht löschen oder eine andere Kalendergruppe anlegen.
- Kalendergruppen abrufen
- Kalendergruppen erstellen
- Kalendergruppen aktualisieren
- Kalendergruppen löschen
Siehe auch
Verwendung der Kalender-REST-API
Authentifizierung
Wie andere Outlook-REST-API, sollten Sie für jede Anfrage an die Kontakte-API ein gültiges Zugriffstoken angeben. Um ein Zugriffstoken zu erhalten, müssen Sie sich registriert und Ihre App identifiziert und die entsprechende Autorisierung erhalten haben.
Sie können mehr über einige optimierte Registrierungs- und Autorisierungsoptionen für Sie herausfinden. Beachten Sie dies, wenn Sie mit den spezifischen Operationen in der Kalender-API fortfahren.
Zugriffsbereiche auf gemeinsame Kalender
Office 365 und Outlook.com Kalender unterstützen die gemeinsame Nutzung. Ein Benutzer, der einen Kalender erstellt hat, kann den Kalender für andere Benutzer freigeben. Die folgenden Bereiche sind erforderlich, um auf einen Kalender zuzugreifen, der für diesen Benutzer freigegeben wurde:
- Für Lesezugriff:
https://outlook.office.com/calendars.read.shared
- Für Lese-/Schreibzugriff:
https://outlook.office.com/calendars.readwrite.shared
Version der API
Die Kalender-REST-API wird in allen Versionen der Outlook REST API unterstützt. Die Funktionalität kann je nach spezifischer Version unterschiedlich sein.
Ziel-Benutzer
Die Kalender-API-Anforderungen werden immer im Namen des aktuellen Benutzers ausgeführt.
Weitere Informationen, die allen Untergruppen von Outlook-REST-API gemeinsam sind, finden Sie unter Outlook-REST-API verwenden.
Ereignisse abrufen
Eine Ereignis-Sammlung oder ein Ereignis abrufen.
Ein Ereignistext kann sowohl im Text als auch im HTML-Format vorliegen. Zurzeit gibt die GET-Operation Ereignistext nur im HTML-Format zurück.
- Eine Kalenderansicht abrufen
- Serienmaster und Einzelereignisse abrufen
- Ereignisinstanzen abrufen
- Abrufen eines Ereignisses
Eine Kalenderansicht abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Dient zum Abrufen der Vorkommen, Ausnahmen und einzelnen Instanzen von Ereignissen in einer Kalenderansicht, die durch einen Zeitbereich definiert werden, aus dem Hauptkalender (../me/calendarview
) des Benutzers oder aus einem anderen Kalender.
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}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_id | string | Die Kalender-ID, wenn Sie eine Kalenderansicht von einem bestimmten Kalender erhalten. |
start_datetime | datetimeoffset | Das Datum und die Uhrzeit für den Beginn des Ereignisses. |
end_datetime | datetimeoffset | Das Datum und die Uhrzeit für das Ende des Ereignisses. |
Hinweis
Standardmäßig umfasst jedes Ereignis in der Antwort alle seine Eigenschaften. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Rufen Sie beispielsweise die Kalenderansicht für den Monat Oktober ab und geben Sie nur die Betreff-Eigenschaft für jedes Ereignis zurück:
GET https://outlook.office.com/api/v1.0/me/calendarview?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject
Antworttyp
Die erweiterten Ereignisse im angegebenen Zeitbereich.
Serienmaster und Einzelereignisse abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Rufen Sie eine Sammlung von Serienmaster- und Einzelinstanzereignissen aus dem Hauptkalender des Benutzers (../me/events
) oder aus einem anderen Kalender. Um erweiterte Ereignisinstanzen abzurufen, können Sie die Kalenderansicht abrufen oder die Instanzen eines Ereignisses abrufen.
GET https://outlook.office.com/api/v1.0/me/events
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_id | string | Die Kalender-ID, wenn Sie Ereignisse aus einem bestimmten Kalender erhalten. |
Hinweis
Jedes Ereignis umfasst in der Antwort alle seine Eigenschaften. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe nächstes Beispiel. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Das folgende Beispiel zeigt, wie man $select
verwendet, um nur die Eigenschaften Subject, Organizer, Start und End jedes Ereignisses in der Antwort anzugeben. Siehe die erste Beispielantwort in Ein Ereignis abrufen (REST) für eine vollständige Liste der Eigenschaften, die für ein Ereignis zurückgegeben würden, wenn Sie nicht $select
verwenden.
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/events?$select=Subject,Organizer,Start,End
Beispielantwort
Statuscode: 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"
}
}
}
]
}
Ereignisinstanzen abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Sie können die Instanzen (Vorkommen) eines Ereignisses für einen bestimmten Zeitraum abrufen. Wenn das Ereignis vom Typ SeriesMaster ist, werden die Vorkommen und Ausnahmen des Ereignisses im angegebenen Zeitbereich zurückgegeben.
GET https://outlook.office.com/api/v1.0/me/events/{event_id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
start_datetime | datetimeoffset | UTC-Datum und Uhrzeit für den Beginn des Ereignisses. |
end_datetime | datetimeoffset | UTC-Datum und Uhrzeit für das Ende des Ereignisses. |
Antworttyp
Die angeforderte Ereignis-Sammlung.
Hinweis
Standardmäßig umfasst jedes Ereignis in der Antwort alle seine Eigenschaften. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Rufen Sie zum Beispiel die Instanzen eines bestimmten Ereignisses für den Monat Oktober ab, schließen Sie nur die Eigenschaften Subject, Start und End jeder Instanz ein:
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
Abrufen eines Ereignisses
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Abrufen eines Ereignisses nach ID.
GET https://outlook.office.com/api/v1.0/me/events/{event_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=
Beispielantwort
Statuscode: 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"
}
}
Antworttyp
Das angeforderte Ereignis.
Hinweis
Standardmäßig enthält die Antwort alle Eigenschaften des neuen Ereignisses. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Das folgende Beispiel zeigt, wie man $select
verwendet, um nur die Eigenschaften Subject, Organizer, Start und End jedes Ereignisses in der Antwort anzugeben.
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=?$select=Subject,Organizer,Start,End
Beispielantwort
{
"@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"
}
}
}
Ereignisse synchronisieren
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Synchronisieren und rufen Sie neue, aktualisierte oder gelöschte Ereignisse in einem bestimmten Zeitbereich aus dem Hauptkalender des Benutzers (../me/calendarview
) oder aus einem anderen Kalender ab. Eine solche Gruppe von Ereignissen in einem Zeitbereich wird auch als Kalenderansicht bezeichnet. Die zurückgegebenen Ereignisse können Vorkommen und Ausnahmen einer wiederkehrenden Serie sowie einzelne Instanzen enthalten.
Die Synchronisation einer Kalenderansicht erfordert in der Regel eine Runde von zwei oder mehr Synchronisationsanforderungen, von denen jede ein GET-Aufruf ist. Um eine Kalenderansicht zu synchronisieren, verwenden Sie die GET-Methode, ähnlich wie Sie eine Kalenderansicht abrufen, mit der Ausnahme, dass Sie bestimmte Anforderungs-Header und deltaToken oder ein skipToken verwenden, wenn dies angemessen ist.
Anforderungsheader
Sie müssen den Header "Prefer: odata.track-changes" in allen Sync-Anforderungen angeben, mit Ausnahme derjenigen, die
skipToken
enthalten, die von einer vorherigen Sync-Anforderung zurückgegeben wird. Suchen Sie in der ersten Antwort nach dem Header Preference-Applied: odata.track-changes, um vor dem Fortfahren zu bestätigen, dass die Ressource die Synchronisierung unterstützt. (Mehr Informationen überskipToken
in Antwortdaten im zweiten Beispiel unten.)Sie können den Header "Prefer: odata.maxpagesize={x}" angeben, um die maximale Anzahl von Ereignissen anzugeben, die eine Synchronisationsanforderung zurückgibt.
Hier ist eine typische Runde der Synchronisierung von Ereignissen in einer Kalenderansicht:
Stellen Sie die erste GET-Anforderung mit dem erforderlichen Header Prefer: odata.track-changes. Die erste Antwort auf eine Synchronisierungsanforderung liefert immer ein deltaToken. (Die zweite und nachfolgende GET-Anforderungen unterscheiden sich von der ersten GET-Anforderung, indem sie entweder ein deltaToken oder ein skipToken enthalten, das in einer früheren Antwort empfangen wurde.)
Wenn die erste Antwort den Header Preference-Applied: odata.track-changes zurückgibt, können Sie mit der Synchronisierung der Ressource fortfahren.
Stellen Sie eine zweite GET-Anforderung. Geben Sie den Header Prefer: odata.track-changes und das deltaToken vom ersten GET zurück, um festzustellen, ob es zusätzliche Ereignisse gibt. Die zweite Abfrage gibt zusätzliche Ereignisse zurück und entweder ein skipToken, wenn mehr Ereignisse verfügbar sind, oder ein deltaToken, wenn das letzte Ereignis synchronisiert wurde, in diesem Fall können Sie aufhören.
Setzen Sie die Synchronisierung fort, indem Sie einen GET-Aufruf senden und ein skipToken einfügen, das vom vorherigen Aufruf zurückgegeben wird. Hören Sie auf, wenn Sie eine endgültige Antwort erhalten, die einen @odata.deltaLink-Header mit einem deltaToken enthält. Die zeigt an, dass die Synchronisierung abgeschlossen wurde.
Werfen Sie einen Blick auf die Syntax für die ersten und nachfolgenden Aufrufe in einer Synchronisierungsrunde.
So synchronisieren Sie im Standardkalender
Ursprüngliche Anforderung:
GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}
Zweite Anforderung oder erste Anforderung einer nachfolgenden Runde:
GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}
Dritte oder nachfolgende Anforderung in der gleichen Runde:
GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}
So synchronisieren Sie in einem bestimmten Kalender
Ursprüngliche Anforderung:
GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}
Zweite Anforderung oder erste Anforderung einer nachfolgenden Runde:
GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}
Dritte oder nachfolgende Anforderung in der gleichen Runde:
GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
user_context | string | Der Benutzerkontext. Sie können den Wert 'me' verwenden, um den Kontext des aktuellen Benutzers anzugeben. Sie können auch das Format users/{upn} verwenden, wobei upn der Hauptname des Benutzers ist, der normalerweise die E-Mail-Adresse des Benutzers ist. |
calendar_id | string | Die Kalender-ID, wenn Sie eine Kalenderansicht von einem bestimmten Kalender erhalten. |
start_datetime | datetimeoffset | Das Datum und die Uhrzeit für den Beginn des Ereignisses. |
end_datetime | datetimeoffset | Das Datum und die Uhrzeit für das Ende des Ereignisses. |
delta_token | string | Die Zeichenfolge deltaToken wird als Teil des Wertes für @odata.deltaLink in der vorherigen Synchronisierungsantwort zurückgegeben. |
skip_token | string | Die Zeichenfolge skipToken wird als Teil des Wertes für @odata.nextLink in der vorherigen Synchronisierungsantwort zurückgegeben. |
Hinweis
- Bei der Angabe von "Prefer: odata.track-changes" in der ersten Anforderung, wenn die Antwort die Synchronisation unterstützt, würde die Antwort "Preference-applied: odata.track-changes" im Header enthalten.
- Wenn Sie versuchen, eine Ressource zu synchronisieren, die nicht unterstützt wird, oder wenn dies nicht die anfängliche Synchronisierungsanforderung ist, sehen Sie den Header "Preference-applied" nicht in der Antwort.
- Sie können das Änderungszeitfenster ändern, indem Sie die Parameter startdatetime und enddatetime ändern.
- Jedes Ereignis umfasst in der Antwort alle seine Eigenschaften.
- Bei einer wiederkehrenden Serie umfasst eine Synchronisationsantwort das gesamte Ereignis für die wiederkehrenden Master- und Ausnahmeereignisse.
- Instanzen einer wiederkehrenden Serie werden abgekürzt und enthalten nur die Eigenschaften Start und End. Sie können den Rest der Ereignisinformationen aus dem wiederkehrenden Master-Ereignis erfassen. Siehe Ereignis-Ressource für Referenzinformationen.
- Die Abfrageparameter
$filter
,$count
,$select
,$skip
,$top
, und$search
können nicht verwendet werden.
Antworttyp
Die erweiterten Ereignisse und abgekürzte Ereignisse innerhalb des angegebenen Zeitbereichs.
Beispiel
Das folgende Beispiel zeigt die ersten und zweiten Synchronisationsanforderungen, um den Standardkalender für den Benutzer zu synchronisieren. Jede Anfrage legt fest, dass jeweils nur ein vollständiges Ereignis zurückgegeben wird:
- Die erste Antwort gibt ein Ereignis zurück, ein
deltaLink
unddeltaToken
. - Die zweite Anforderung verwendet
deltatoken
. Die zweite Antwort gibt ein Ereignis zurück, einnextLink
undskipToken
.
Um die Synchronisation abzuschließen, verwenden Sie skipToken
, was von der vorherigen Sync-Anfrage zurückgegeben wird, bis die Sync-Antwort deltaLink
und deltaToken
zurückgibt, in diesem Fall ist diese Runde der Synchronisation abgeschlossen. Speichern Sie deltaToken
für die nächste Synchronisierungsrunde.
Weitere Informationen finden Sie unter Ereignisse in einer Outlook-Kalenderansicht synchronisieren.
Beispiel für anfängliche Anforderung
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
Beispieldaten für die anfängliche Antwort
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"
}
Beispiel für zweite Anforderung
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
Beispieldaten für die zweite Antwort
{
"@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"
}
Besprechungszeiten finden
Dieses Feature ist derzeit in den Versionen v2. 0 und Beta verfügbar.
Besprechungsräume abrufen (Vorschauversion)
Dieses Feature ist derzeit nur in der Beta-Version verfügbar.
Ereignisse erstellen
Ein Kalenderereignis erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Erstellen Sie ein Ereignis im Hauptkalender des Benutzers oder in einem bestimmten Kalender, indem Sie es an den Endpunkt events
des Kalenders senden. Wenn das Ereignis erstellt wird, sendet der Server Einladungen an alle Teilnehmer.
Standardmäßig sind die Zeitwerte Start und End in UTC. Sie können Zeitzonen für Start und End angeben, die Zeit in der entsprechenden Zeitzone ausdrücken und einen Zeitversatz zu UTC angeben.
Das folgende Beispiel zeigt die Zuordnung von Zeitwerten in der Pacific Standard Time. Beachten Sie, dass Sie bei Angabe einer Zeitzone auch einen Wert für die andere Zeitzone angeben müssen.
POST https://outlook.office.com/api/v1.0/me/events
POST https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_id | string | Die Kalender-ID. |
Beispielanfrage
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"
}
]
}
Beispielantwort
Statuscode: 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"
}
}
}
Antworttyp
Das neue Ereignis.
Standardmäßig enthält die Antwort alle Eigenschaften des neuen Ereignisses. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben.
Das folgende Beispiel soll nur die Eigenschaften Start und End des neuen Ereignisses in die Antwort aufnehmen.
POST https://outlook.office.com/api/v1.0/me/events?$Select=Start,End
Ereignisse aktualisieren
Kalenderereignis aktualisieren
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Ein Ereignis ändern. Nur die Eigenschaften, die Sie angeben, werden geändert. Wenn der Benutzer der Organisator ist, sendet der Server Besprechungsaktualisierungen an alle Teilnehmer.
PATCH https://outlook.office.com/api/v1.0/me/events/{event_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
Geben Sie alle beschreibbaren Kontakt-Eigenschaften im Anforderungstext an.
Beispielanfrage
PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=
Content-Type: application/json
{
"Location": {
"DisplayName": "Your office"
}
}
Beispielantwort
Statuscode: 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"
}
}
}
Antworttyp
Das aktualisierte Ereignis. Wenn der Benutzer der Organisator ist, sendet der Server Besprechungsaktualisierungen an alle Teilnehmer.
Standardmäßig enthält die Antwort alle Eigenschaften des aktualisierten Ereignisses. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben.
PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE1MFKPQWAAA=?$select=Location
Auf Ereignisse antworten
Ereignis annehmen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Nimmt das angegebene Ereignis an.
POST https://outlook.office.com/api/v1.0/me/events/{event_id}/accept
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. Erforderlich. |
Text-Parameter | ||
Kommentar | string | In der Antwort enthaltener Text. Optional. |
SendResponse | boolesch | true ,wenn eine Antwort an den Organisator gesendet werden soll; andernfalls false . Optional. Der Standardwert lautet true . |
Beispielanfrage
POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/accept
Content-Type: application/json
{
"Comment": "Great idea!",
"SendResponse": "true"
}
Antwort
Eine erfolgreiche Antwort wird mit einem HTTP-202-Antwortcode angegeben.
Ereignis vorläufig annehmen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Nimmt das angegebene Ereignis mit Vorbehalt an.
POST https://outlook.office.com/api/v1.0/me/events/{event_id}/tentativelyaccept
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. Erforderlich. |
Text-Parameter | ||
Kommentar | string | In der Antwort enthaltener Text. Optional. |
SendResponse | boolesch | true ,wenn eine Antwort an den Organisator gesendet werden soll; andernfalls false . Optional. Der Standardwert lautet true . |
Beispielanfrage
POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/tentativelyaccept
Content-Type: application/json
{
"Comment": "I'll confirm later!",
"SendResponse": "true"
}
Antwort
Eine erfolgreiche Antwort wird mit einem HTTP-202-Antwortcode angegeben.
Ereignis ablehnen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Lehnt die Einladung zu dem angegebenen Ereignis ab.
POST https://outlook.office.com/api/v1.0/me/events/{event_id}/decline
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. Erforderlich. |
Text-Parameter | ||
Kommentar | string | In der Antwort enthaltener Text. Optional. |
SendResponse | boolesch | true ,wenn eine Antwort an den Organisator gesendet werden soll; andernfalls false . Optional. Der Standardwert lautet true . |
Beispielanfrage
POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/decline
Content-Type: application/json
{
"Comment": "Sorry, maybe next time!",
"SendResponse": "true"
}
Antwort
Eine erfolgreiche Antwort wird mit einem HTTP-202-Antwortcode angegeben.
Ereignisse weiterleiten (Vorschauversion)
Dieses Feature ist derzeit nur in der Beta-Version verfügbar.
Ereignisse löschen
Ein Kalenderereignis löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Verschieben Sie ein Ereignis in den Ordner "Gelöschte Objekte" des angemeldeten Benutzers. Wenn es sich bei dem Ereignis um eine Besprechung handelt und der angemeldete Benutzer der Organisator ist, sendet der Server Stornierungen an alle Teilnehmer.
DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
Beispielanfrage
DELETE https://outlook.office.com/api/v1.0/me/events/AAMkAGE0M4v1OAAA=
Beispielantwort
Status code: 204
Ereignisse absagen (Vorschauversion)
Dieses Feature ist derzeit nur in der Beta-Version verfügbar.
Anlagen abrufen
Sie können eine Anlagensammlung oder einen Anhang abrufen.
Eine Anlagensammlung abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Rufen Sie die Anlagen eines bestimmten Ereignisses ab.
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
Antworttyp
Eine Anlagensammlung, die vom Typ FileAttachment oder ItemAttachment sein kann.
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments
Beispielantwort
Statuscode: 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
}
]
}
Eine Anlage abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Rufen Sie eine Anlage von einem bestimmten Ereignis ab.
GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
attachment_id | string | Die Anlagen-ID. |
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Antworttyp
Die angeforderte Dateianlage oder Elementanlage.
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=
Beispielantwort
Statuscode: 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
}
Anlagen erstellen
Sie können für ein Ereignis eine Dateianlage erstellen oder eine Elementanlage erstellen.
Eine Dateianlage erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Eine Dateianlage zu einem Ereignis hinzufügen.
POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
Text-Parameter | ||
@odata.type | string | #Microsoft.OutlookServices.FileAttachment |
Name | string | Der Name der Anlage. |
ContentBytes | Binär | Die Datei, die angehängt werden soll. |
Antworttyp
Die neue Dateianlage.
Eine Elementanlage erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Fügen Sie eine Anlage zu einem Ereignis hinzu.
POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
Text-Parameter | ||
@odata.type | string | #Microsoft.OutlookServices.ItemAttachment |
Name | string | Der Name der Anlage. |
Element | Eine Nachricht-, Ereignis- oder Kontakt-Entität. | Das anzufügende Element. |
Antworttyp
Die neue Elementanlage.
Eine Verweisanlage erstellen
Minimal benötigter Bereich
https://outlook.office.com/calendars.readwrite
Eine Verweisanlage zu einem Ereignis hinzufügen.
Dieses Feature ist derzeit nur in der Beta-Version verfügbar.
Anlagen löschen
Eine Ereignisanlage löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Löscht die angegebene Anlage eines Ereignisses. Die Anlage kann eine Dateianlage oder Elementanlage sein.
DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
event_id | string | Die Ereignis-ID. |
attachment_id | string | Die Anlagen-ID. |
Beispielanfrage
DELETE https:/outlook.office.com/api/v1.0/me/events/AAMkAGE0MG4v1OAAA=/attachments/AAMkAGITG9yAAA=
Beispielantwort
Status code: 204
Erinnerungen abrufen
Rufen Sie eine Liste von Ereigniserinnerungen zwischen zwei Terminen aus einem Kalender ab.
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Dieses Feature ist derzeit in den Versionen v2. 0 und Beta verfügbar.
Erinnerungen „schlummern“ lassen
Eine Erinnerung per Snooze-Funktion auf eine neue Zeit verschieben.
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Dieses Feature ist derzeit in den Versionen v2. 0 und Beta verfügbar.
Erinnerungen zurückweisen
Mit dieser API können Sie eine ausgelöste Erinnerung schließen.
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Dieses Feature ist derzeit in den Versionen v2. 0 und Beta verfügbar.
Kalender abrufen
Sie können eine Kalendersammlung oder einen Kalender abrufen.
Eine Kalender-Sammlung abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Ruft alle Kalender des Benutzers (calendars
) oder die Kalender einer bestimmten Kalendergruppe ab.
GET https://outlook.office.com/api/v1.0/me/calendars
GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calender_group_id | string | Die Kalendergruppen-ID. |
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/calendars
Beispielantwort
Statuscode: 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=="
}
]
}
Antworttyp
Die gewünschte Kalender-Sammlung.
Einen Kalender abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Einen Kalender nach ID abrufen. Sie können den Hauptkalender des Benutzers über den Endpunkt ../me/calendar
abrufen.
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_id | string | Die Kalender-ID. |
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/calendars/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=
Beispielantwort
Statuscode: 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=="
}
Antworttyp
Der gewünschte Kalender.
Kalender erstellen
Einen Kalender erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Erstellen Sie einen Kalender in der Standardkalendergruppe über die Verknüpfung ../me/calendars
oder in einer bestimmten Kalendergruppe über den Endpunkt calendars
.
POST https://outlook.office.com/api/v1.0/me/calendars
POST https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calender_group_id | string | Die Kalendergruppen-ID, wenn Sie Kalender von einer bestimmten Gruppe abrufen. |
Text-Parameter | ||
Name | string | Der Name des neuen Kalenders |
Beispielanfrage
POST https://outlook.office.com/api/v1.0/me/calendars
Content-Type: application/json
{
"Name": "Social"
}
Beispielantwort
Statuscode: 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=="
}
Antworttyp
Der neue Kalender.
Kalender aktualisieren
Einen Kalender aktualisieren
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Beschreibbare Eigenschaften eines Kalenders ändern.
PATCH https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_id | string | Die Kalender-ID. |
Text-Parameter | ||
Name | string | Der neue Name des Kalenders. |
Beispielanfrage
PATCH https://outlook.office.com/api/v1.0/me/calendars/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=
Content-Type: application/json
{
"Name": "Social events"
}
Beispielantwort
Statuscode: 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=="
Antworttyp
Der aktualisierte Kalender.
Kalender löschen
Einen Kalender löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_id | string | Die Kalender-ID. |
Beispielanfrage
DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}
Beispielantwort
Status code: 204
Kalendergruppen abrufen
Sie können eine Kalendergruppensammlung oder eine Kalendergruppe abrufen.
Hinweis
Outlook.com unterstützt nur die Standardkalendergruppe, die über die Verknüpfung ../me/calendars
erreichbar ist.
Eine Kalendergruppensammlung abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Rufen Sie die Kalendergruppen in einem Postfach ab.
GET https://outlook.office.com/api/v1.0/me/calendargroups
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/calendargroups
Beispielantwort
Statuscode: 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"
}
]
}
Antworttyp
Die gewünschte Kalendergruppen-Sammlung.
Eine Kalendergruppe abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.read
- wl.calendars
- wl.contacts_calendars
Rufen Sie eine Kalendergruppe nach ID ab.
GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_group_id | string | Die Kalendergruppen-ID. |
Beispielanfrage
GET https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=
Beispielantwort
{
"@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=="
}
Antworttyp
Die gewünschte Kalendergruppe.
Kalendergruppen erstellen
Eine Kalendergruppe erstellen. Name ist die einzige beschreibbare Eigenschaft für eine Kalendergruppe.
Hinweis
Outlook.com unterstützt nur die Standardkalendergruppe, die über die Verknüpfung ../me/calendars
erreichbar ist. Sie können keine andere Kalendergruppe in Outlook.com erstellen.
Eine Kalendergruppe erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
POST https://outlook.office.com/api/v1.0/me/calendargroups
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
Text-Parameter | ||
Name | string | Der Name der Kalendergruppe. |
POST https://outlook.office.com/api/v1.0/me/calendargroups
Content-Type: application/json
{
"Name": "Birthdays"
}
Beispielantwort
Statuscode: 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"
}
Antworttyp
Die neue Kalendergruppe.
Kalendergruppen aktualisieren
Eine Kalendergruppe aktualisieren
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
Ändern Sie den Namen einer Kalendergruppe. Name ist die einzige beschreibbare Eigenschaft einer Kalendergruppe.
PATCH https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_group_id | string | Die Kalendergruppen-ID. |
Text-Parameter | ||
Name | string | Der Name der aktualisierten Kalendergruppe. |
PATCH https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=
{
"Name": "Holidays"
}
Beispielantwort
Statuscode: 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"
}
Antworttyp
Die aktualisierte Kalendergruppe.
Kalendergruppen löschen
Hinweis
Outlook.com unterstützt nur die Standardkalendergruppe, die über die Verknüpfung ../me/calendars
erreichbar ist. Löschen Sie diese Kalendergruppe nicht.
Eine Kalendergruppe löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
- https://outlook.office.com/calendars.readwrite
- wl.calendars_aktualisieren
- wl.events_erstellen
DELETE https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
calendar_group_id | string | Die Kalendergruppen-ID. |
Beispielanfrage
DELETE https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM4xLGAAA=
Beispielantwort
Status code: 204
Nächste Schritte
Egal, ob Sie bereit sind, eine App zu erstellen oder einfach nur mehr darüber erfahren möchten, wir haben alles im Griff.
- Beginnen Sie mit den E-Mail-, Kalender- und Kontakte-REST-APIs.
- Möchten Sie Beispiele sehen? Wir haben sie.
Oder erfahren Sie mehr über die Verwendung der Office 365-Plattform:
- Outlook-REST-API im Outlook-Dev-Center
- Überblick über die Entwicklung auf der Office 365-Plattform
- Office 365 App-Authentifizierung und Ressourcen-Autorisierung
- Registrieren Sie Ihre Anwendung manuell bei Azure AD, damit sie auf Office 365-APIs zugreifen kann
- E-Mail-API-Verweis
- Kontakte-API-Verweis
- Aufgaben-REST-API (Vorschauversion)
- OneDrive-API
- Ermittlungsdienst REST-API-Operationen-Verweis
- Ressourcenreferenz für die REST-APIs E-Mail, Kalender und Kontakte