Read

This Snap provides the functionality to check calendar availability for appointment attendees in Microsoft Exchange through the Microsoft Exchange web services. The Snap requires an input Exchange availability record specific to the attendees and the date and time of the appointment, and it sends the request to Microsoft Exchange. If the result is successful, the list of dates and times that are available will be returned with any conflicts. However, if there is an error in performing the read, the error view will contain the error message. 
 

• Expected upstream Snaps: A document is expected as an input into the Exchange Read Snap.  The upstream Snap can be either a JSON-generated Snap or a file Snap that reads in the document information to check meeting attendee availability. 

• Expected downstream Snaps: A document is the expected output of the Exchange Snap with a JSON payload containing meeting attendee availability information. The downstream Snap can be any Snap that consumes a document such as a file Snap or a database Snap. 

• Expected input: The following JSON is a sample of the input.
  

In Microsoft's API, there are many additional fields that can be specified, but the fields below are the minimum required fields to read an appointment and therefore are what this Snap supports:

{
    "Id": "1",
    "attendees": "test@test.com",
    "startDate": "2014-1-18 13:00:00",
    "endDate": "2014-1-19 16:00:00",
    "availabilityType": "FreeBusyAndSuggestions"
}

• Expected output: Each document contains Map data, which includes the ID of the object and the dates and times where there is a meeting conflict.  If there are no meeting conflicts, an empty result is returned. The following JSON is a sample of the output generated when a meeting has been successfully created:

[
   {
      "test@test.com":[
         {
            "date":"2014-01-18T00:00:00.000+0000",
            "quality":"Excellent",
            "timeSuggestions":[
               {
                  "meetingTime":"2014-01-18T00:00:00.000+0000",
                  "quality":"Excellent",
                  "conflicts":[
                     {
                        "conflictType":"IndividualAttendeeConflict",
                        "numberOfMembers":0,
                        "numberOfMembersAvailable":0,
                        "numberOfMembersWithConflict":0,
                        "numberOfMembersWithNoData":0,
                        "freeBusyStatus":"Free"
                     }
                  ],
                  "workTime":true
               },
               {
                  "meetingTime":"2014-01-18T00:30:00.000+0000",
                  "quality":"Good",
                  "conflicts":[
                     {
                        "conflictType":"IndividualAttendeeConflict",
                        "numberOfMembers":0,
                        "numberOfMembersAvailable":0,
                        "numberOfMembersWithConflict":0,
                        "numberOfMembersWithNoData":0,
                        "freeBusyStatus":"Free"
                     }
                  ],
                  "workTime":true
               },
               {
                  "meetingTime":"2014-01-18T16:00:00.000+0000",
                  "quality":"Good",
                  "conflicts":[
                     {
                        "conflictType":"IndividualAttendeeConflict",
                        "numberOfMembers":0,
                        "numberOfMembersAvailable":0,
                        "numberOfMembersWithConflict":0,
                        "numberOfMembersWithNoData":0,
                        "freeBusyStatus":"Free"
                     }
                  ],
                  "workTime":true
               }
            ]
         }
      ]
   }
]

• Expected usage: The main purpose of the Exchange Read Snap is to check availability for a meeting attendee in Exchange. The availability information returned can contain the list of conflicts for meeting attendees and suggest available meeting times.

[None]

Works in Ultra Task Pipelines.

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Microsoft Exchange Accounts for information on setting up this type of account.

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Required. An object type that will be read from Exchange.

Example: AvailabilityEntity

Default value: AvailabilityEntity