Get User Bookings

By Elliot Dooleysmith
1 min

Overview

Request for User Bookings based on date.

This will return the user's bookings based date.

Details

Type

POST

Endpoint

{{url}}/api/User/GetBookings

Request

The request will have five valid parameters.

The Id or EmailAddress can be used; at least one is required.
The date is optional and used to find the user's status for a future day; if not included the current date should be used.

Example

{ "Id": int, "EmailAddress": "string (email address)", "Date": "dd/MM/yyyy" }

Response

The response will include the user's bookings.

Example

{ "Id": int, "EmailAddress": "string (email address)", "Date": "yyyy/MM/DD", "Bookings": Array[ Object{ "Per": int, "Id": int, "AllDay": int, "Subject": "string", "Organizer": "string (name)", "OrganizerEmail": "string (email address)", "StartTime": "2023-11-24T12:22:57", "EndTime": "2023-11-24T12:52:57", "BookedBy": int (user id), "ResId": int, "RecurringOption": "", "MeetingStatus": "string" } ] }

 

Use case

This API will be used for the schedule view to display current bookings for selected users.

https://www.figma.com/file/PYl87VrybgtPIqMQr34kJ6/RX-Outlook-Add-in?type=design&node-id=493%3A52146&mode=dev&t=2EFMCPGXmlxK4Yme-1

 

Related content