Versions Compared

Key

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

...

This will return the user's assigned space and current & future availability bookings for this space.

Details

Type

POSTGET

Endpoint

{{url}}/api/UserUsers/GetAssignedSpace

Request

The request will have two valid parameters.

...

The response will include the user’s information as specified in the request.

  • UserId

  • EmailAddress

Also an array of the user’s assigned spaces.

The Assigned resource’s ID (ResId) and display name (ResName) will be returned.

...

  • AvailableForColleagueDates - An array of objects which include start and end dates.

    • Id - A unique ID value for each availability booking.

    • StartDate - The start date for an availability booking.

    • EndDate - The end date for an availability booking.

Example

Code Block
languagejson
{
  "UserId": int,
  "EmailAddress": "string (email address)",
  "AssignedSpaceAssignedSpaces": Array[
    Object{
      "ResId": int,
      "ResName": "string",
      "SpaceType": "string",
      "IconPath": "string"
      "MapId": Array[int,int],
      "AvailableForColleagueDates": Array[
        Object{
          "Id": int,
          "StartDate": "dd/MM/yyyy",
          "EndDate": "dd/MM/yyyy",
        }
      ]
    },
    Object{
      "ResId": int,
      "ResName": "string",
      "SpaceType": "string",
      "IconPath": "string"
      "MapId": Array[int,int],
      "AvailableForColleagueDates": Array[
        Object{
          "Id": int,
          "StartDate": "dd/MM/yyyy",
          "EndDate": "dd/MM/yyyy",
        }
      ]
    }
  ]
}