Reserve EXCHANGE CONNECTOR EWS CALLS (USING OAUTH)
The following article describes the EWS calls which are used in the Reserve Exchange Connector to retrieve messages from and send messages to the Microsoft Exchange server.
Note: Graph API is now available for the Exchange Connector to Reserve customer using the integration. Contact Tango Reserve Support if you have any questions.
CALL LIST
| GetServerTimeZones |
Used to get all time zones that are available in the Exchange server https://msdn.microsoft.com/en-us/library/office/dd899430(v=exchg.140).aspx |
| Subscribe |
Used to subscribe to push, pull and streaming notifications https://msdn.microsoft.com/en-us/library/office/aa566188(v=exchg.140).aspx |
|
GetStreamingEvents |
Used to get streaming notification events from Exchange https://msdn.microsoft.com/EN-US/library/office/ff406172(v=exchg.150).aspx |
| GetEvents |
Used to get pull notification events from Exchange https://msdn.microsoft.com/en-us/library/office/aa566199(v=exchg.150).aspx |
| FindItem |
Used to find calendar events (meetings) or folders that match some criteria https://msdn.microsoft.com/en-us/library/office/aa566107(v=exchg.140).aspx |
| GetItem |
Used to get calendar events (meetings) by ItemId from organizer’s and resource calendars https://msdn.microsoft.com/en-us/library/office/aa565934(v=exchg.150).aspx |
| GetFolder |
Used to get folders by FolderId https://msdn.microsoft.com/en-us/library/office/aa580274(v=exchg.150).aspx |
| ResolveNames |
Used to find mailbox users by their display names https://msdn.microsoft.com/en-us/library/office/aa563518(v=exchg.150).aspx |
| CreateItem |
Used to create meetings and reply emails to the organizers of meetings in Exchange https://msdn.microsoft.com/EN-US/library/office/aa563797(v=exchg.150).aspx |
| UpdateItem |
Used to update meetings in Exchange https://msdn.microsoft.com/en-us/library/office/aa581084(v=exchg.140).aspx |
|
Autodiscover Service
|
|
| GetUserSettings |
Used to get Exchange user/room settings such as EWS URL and grouping information https://msdn.microsoft.com/en-us/library/office/dd877096(v=exchg.150).aspx |
IMPERSONATION ELEMENTS
The calls may include ExchangeImpersonation element in the header of a request to impersonate some account when the Exchange Connector is configured to use OAuth with impersonation: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/exchangeimpersonation.
Of the calls listed in the table above, all but the GetServerTimeZones, GetStreamingEvents, and GetUserSettings use the Exchange Impersonation element as part of the SOAP operation to impersonate an account. (See https://msdn.microsoft.com/en-us/library/office/aa565690(v=exchg.150).aspx )
SUBSCRIBE
The Subscribe operation is used to subscribe client applications to either push or pull notifications. It is important to be aware that the structure of the request messages and responses is different depending on the type of event notification. The Exchange Connector must subscribe to Events to receive requests from the Exchange server when a user creates meeting appointments.
GET STREAMING EVENTS
The GetStreamingEvents operation is used by streaming subscription clients to request notifications from the Client Access server. The GetStreamingEvents response returns an array of items and events that have occurred in a mailbox since the last the notification.
The Exchange Connector may be optionally configured to use Streaming Events as a means for interacting with the Exchange server. While this is the method recommended by Microsoft to ensure the most up-to- date notification of events, there may be performance issues for large scale applications.
GET EVENTS
The GetEvents operation is used by pull subscription clients to request notifications from the Client Access server. The GetEvents operation response returns an array of items and events that have occurred in a mailbox since the last the notification.
The Exchange Connector may be optionally configured to use pull notification events to retrieve messages for mailboxes from the Exchange server. Issues with pull notifications can include significant delay in notifications, as Microsoft reports that notification queueing can be inconsistent.
FIND ITEM
The FindItem operation identifies items that are located in a specified folder. You can specify the following in a FindItem request:
- Whether the search is a shallow or soft-deleted Specifying this is required. Note that a soft-deleted traversal combined with a search restriction will result in zero items returned, even if there are items that match the search criteria.
- The response shape of items. This identifies the properties that are returned in the response. Specifying this is
- The root folders from which to perform the search. Specifying this is
- The paging mechanism for returning view data in pages. Specifying this is
- Options for grouping and sorting the items that are
- Search restrictions for filtering the items that are
The Exchange Connector uses this call to find meetings or folders that match search criteria when performing synchronizations from Reserve reservation requests.
RESOLVE NAMES
This operation can be used to verify aliases and resolve display names to the appropriate mailbox user. If ambiguous names exist, the ResolveNames operation response provides information about each mailbox user so that the client application can resolve the names. The Exchange Connector uses this operation to find the mailbox for users given only the display name of a user.
CREATE ITEM
The CreateItem operation creates items in the Exchange store. This can be used to create calendar items and meeting requests. In the case of the Exchange Connector, it is used to create meeting requests and to reply to responses to organizers of meeting requests.
UPDATE ITEM
The UpdateItem operation is used to modify the properties of an existing item in the Exchange store.
This operation allows the Exchange Connector to Append new data to an existing meeting request, Set data on an existing property of a meeting request, or Delete a property from a meeting request. As changes are made to a reservation in Reserve, the corresponding Meeting in the Exchange server is updated through this operation.
GET USERS SETTINGS
The GetUserSettings operation contains a query for users' client access configuration. The Exchange Connector makes this call to get the display name and mailbox information of a user in conjunction with Streaming Events.
EXCHANGE MEETING FIELDS AND RESERVE
The data elements or fields from the Exchange Meeting that are used in Reserve are limited to the following information (highlighted in yellow).
Important Note: Attachments, Message Body, Notes including URL’s for online meetings are not used or stored in Reserve.
These data elements/fields map to the following information in Reserve:
|
Exchange Meeting Field/Data |
Reserve Reservation Field |
|
Title/Subject |
Reservation Name |
|
Organizer |
Reservation Owner |
|
Required Attendees |
Invitees |
|
Optional Attendees |
Invitees |
|
Start |
Start Date/Time |
|
End |
End Date/Time |
|
Location |
Asset |
Additional Resources:
Reserve for Exchange Document – click here
Register the Application for OAuth – click here
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article