Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint

{{url}}/api/User/BookingsGetBookings

Request

The request will have five valid parameters.

The UserId 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.

...

Code Block
languagejson
{
  "UserIdId": 13int,
  "EmailAddress": "charlotte.hill@email.comstring (email address)",
  "Date": "dd/MM/yyyy"
}

...

Code Block
languagejson
{
  "UserIdId": 13int,
  "EmailAddress": "charlotte.hill@email.comstring (email address)",
  "Date": "yyyy/MM/DD",
  "Bookings": Array[
    Object{
      "Per": 0int,
      "BookIdId": "401006"int,
      "AllDay": 0int,
      "Subject": "Anonymous Bookingstring",
      "Organizer": "Charlottestring Hill(name)",
      "OrganizerEmail": "charlotte.hill@email.com",
      "BookedUser": "Charlotte Hill"string (email address)",
      "StartTime": "2023-11-24T12:22:57",
      "EndTime": "2023-11-24T12:52:57",
      "BookedBy": 13 int (user id),
      "ResId": 0int,
      "RecurringOption": "",
      "MeetingStatus": "Session in Progressstring"
    }
  ]
}

Use case

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

...