The Workplace Service Delivery (WSD) Group Reservation API provides endpoints for managing group reservations.

Group reservations allow you to reserve different locations for various people (groups) for the same meeting.

This API runs in the sn_wsd_rsv namespace. To access this API, the caller must have the sn_wsd_core.workplace_user role and the Workplace Reservation Management (sn_wsd_rsv) plugin must be activated.

For additional information on Workplace Reservation Management, see Workplace Reservation Management.

WSD Group Reservation - GET /api/sn_wsd_rsv/group_reservation/{parent_id}

Returns the parent and all child reservations for a specified group reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/group_reservation/{parent_id}

Default URL: /api/sn_wsd_rsv/group_reservation/{parent_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 1. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
parent_id
Sys_id of the parent reservation record.

When a group reservation is created, one group parent record and one or more child reservation records are created. Reservation records contain a field called reservation_subtype, that indicates the type of reservation record. For group parent records, this field is set to "Group parent" to indicate that it is a group parent record. For child records, this field is set to "Single".

Within a child record, the sys_id of the associated parent reservation record is in the source_reservation field.

Data type: String

Table: Workplace Reservation [sn_wsd_rsv_reservation]
Table 2. Query parameters
Name Description
None
Table 3. Request body parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 4. Request headers
Header Description
Accept Data format of the request body. Supported types: application/json, application/xml or, text/xml.

Default: application/json
Table 5. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters

Name Description
result Details about the parent and children reservations associated with the group reservation.

Data type: Object

{
  "result": {
    "parent": {Object},
    "children": [Array]
}

Example: cURL request

The following code example shows how to retrieve the details for a group reservation.

curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/e2245051533b01103cf7ddeeff7b12d6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Return results:

{
  "result": {
    "parent": {
      "sys_id": "e2245051533b01103cf7ddeeff7b12d6",
      "number": "WRES0001142",
      "start": "2022-05-30T04:30:00Z",
      "end": "2022-05-30T05:30:00Z",
      "sys_created_on": "2022-05-30T04:19:02Z",
      "sys_updated_on": "2022-05-30T04:19:04Z",
      "source_reservation": null,
      "check_in_state": {
        "value": "not_required",
        "display_value": "Not required"
      },
      "external_id": null,
      "external_ical": null,
      "active": true,
      "state": {
        "value": "confirmed",
        "display_value": "Confirmed"
      },
      "sensitivity": {
        "value": "normal",
        "display_value": "Normal"
      },
      "reservation_type": {
        "value": "space",
        "display_value": "Space"
      },
      "reservation_subtype": {
        "value": "group_parent",
        "display_value": "Group parent"
      },
      "reservation_purpose": {
        "value": "meeting",
        "display_value": "Meeting"
      },
      "attendees": null,
      "number_of_attendees": 1,
      "is_parent": true,
      "subject": "Test#52",
      "virtual_meeting": null,
      "recording_details": [],
      "sync_state": {
        "value": "not_required",
        "display_value": "Synchronization not required"
      },
      "sub_source": {
        "value": "servicenow_workplace_service_delivery",
        "display_value": "ServiceNow Workplace Service Delivery"
      },
      "last_updated_sub_source": {
        "value": "servicenow_workplace_service_delivery",
        "display_value": "ServiceNow Workplace Service Delivery"
      },
      "reservable_module": {
        "sys_id": "5db44502dbb650106c731dcd13961937",
        "name": "Desks",
        "title": "Desks",
        "inline_title": "desk",
        "font_awesome_icon": "fa-desktop",
        "reservable_table": "sn_wsd_core_space",
        "reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
        "short_description": "Reserve a single desks",
        "reservable_type": "location",
        "require_subject": null,
        "require_cancel_notes": false,
        "virtual_meeting_provider": {
          "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
          "display_value": "Template"
        },
        "allow_invitees": null,
        "display_number_of_attendees": null,
        "display_on_behalf_of": "1",
        "display_sensitivity": null,
        "max_days_in_future": "90",
        "allow_whole_day": "1",
        "require_whole_day": null,
        "selection_type": "unit",
        "reservable_container_field": null,
        "reservable_quantity_field": null,
        "apply_to_shift": null,
        "max_occurrences": "90",
        "enable_facet_filter": false,
        "search_limit": 10000,
        "enable_ical_generation": null,
        "enable_group_reservations": "1",
        "enable_browse_near_a_person": "1",
        "enable_browse_by_area": "1",
        "display_value": "Desks",
        "browse_near_a_person_enabled": true,
        "browse_by_area_enabled": true,
        "reservable_columns": [
          "sys_id",
          "external_id",
          "email",
          "name",
          "title",
          "description",
          "image",
          "number",
          "site",
          "campus",
          "building",
          "floor",
          "area",
          "capacity",
          "reservable_quantity",
          "location_type",
          "order",
          "requires_check_in",
          "is_reservable"
        ],
        "layout_mapping": {
          "title": [
            "name"
          ],
          "description": [
            "description"
          ],
          "subtitle": [
            "campus",
            "building",
            "floor",
            "area"
          ],
          "subtitle_asc": [
            "area",
            "floor",
            "building",
            "campus"
          ],
          "image": "image",
          "body": [
            {
              "label": "Capacity",
              "icon": "fa-users",
              "field": "capacity",
              "field_to_display": ""
            },
            {
              "label": "Standard services",
              "icon": "fa-check",
              "field": "standard_services",
              "field_to_display": "name"
            },
            {
              "label": "Reservable purposes",
              "icon": "fa-tags",
              "field": "reservable_purposes",
              "field_to_display": "name"
            }
          ]
        },
        "timeSlots": [
          {
            "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
            "name": "All day",
            "short_description": "8am - 6pm",
            "slot_start": "08:00",
            "slot_end": "18:00"
          },
          {
            "sys_id": "de131cf2dbb5f01038e42b24ca961931",
            "name": "Before noon",
            "short_description": "8am - 12pm",
            "slot_start": "08:00",
            "slot_end": "12:00"
          },
          {
            "sys_id": "6e99ab5ddbb930102e8e853e68961929",
            "name": "After noon",
            "short_description": "1pm - 6pm",
            "slot_start": "13:00",
            "slot_end": "18:00"
          }
        ],
        "buildingSysIds": [
          "9e0364cedb3650106c731dcd1396192b"
        ],
        "reservable_views": [
          {
            "type": "card",
            "label": "Card view",
            "iconClass": "fa-th-large",
            "isDefault": true,
            "order": "1"
          },
          {
            "type": "schedule",
            "label": "Schedule view",
            "iconClass": "fa-calendar-o",
            "isDefault": false,
            "order": "2"
          }
        ],
        "checkin_before_minutes": 30,
        "reservation_paths": [
          {
            "value": "browse_all",
            "displayValue": "Browse all"
          },
          {
            "value": "browse_near_a_person",
            "displayValue": "Browse near a person"
          },
          {
            "value": "browse_by_area",
            "displayValue": "Browse by area"
          }
        ],
        "override_approval_policy": "never_required"
      },
      "notification_recipients": null,
      "notification_custom_message": null,
      "opened_by": {
        "sys_id": "6816f79cc0a8016401c5a33be04be441",
        "value": "6816f79cc0a8016401c5a33be04be441",
        "displayValue": "System Administrator",
        "display_value": "System Administrator",
        "name": "System Administrator",
        "user_name": "admin",
        "table": "sys_user",
        "avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
        "initials": "SA",
        "email": "admin@example.com",
        "label": "System Administrator, Finance"
      },
      "requested_for": {
        "sys_id": "6816f79cc0a8016401c5a33be04be441",
        "value": "6816f79cc0a8016401c5a33be04be441",
        "displayValue": "System Administrator",
        "display_value": "System Administrator",
        "name": "System Administrator",
        "user_name": "admin",
        "table": "sys_user",
        "avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
        "initials": "SA",
        "email": "admin@example.com",
        "label": "System Administrator, Finance"
      },
      "edit_restriction": {
        "value": "no_restriction",
        "display_value": "No restriction"
      },
      "source": {
        "value": "servicenow",
        "display_value": "Workplace Services"
      },
      "source_icon": {
        "classNames": "fa fa-calendar-check-o",
        "tooltip": "Reservation is confirmed",
        "imgSrc": ""
      },
      "shift": null,
      "locations": [
        {
          "sys_id": "73c2698adb7210106c731dcd13961968",
          "name": "B1-03-03",
          "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
          "display_value": "B1-03-03",
          "capacity": 1,
          "label_value": "Workspace/Desk name",
          "email": null,
          "reservable_module": {
            "sys_id": "5db44502dbb650106c731dcd13961937",
            "name": "Desks",
            "title": "Desks",
            "inline_title": "desk"
          },
          "region": {
            "sys_id": "2d626c4edb3650106c731dcd1396194b",
            "display_value": "Europe",
            "active": true
          },
          "site": {
            "sys_id": "b17220cedb3650106c731dcd1396197a",
            "display_value": "Western Europe",
            "active": true
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "active": true
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "active": true,
            "timezone": {
              "value": "Europe/Amsterdam",
              "displayValue": "Europe/Amsterdam"
            }
          },
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "active": true
          },
          "area": {
            "sys_id": "410ff04edb7650106c731dcd13961973",
            "display_value": "Desks C1",
            "active": true
          },
          "reservation": {
            "sys_id": "2a24d0d1533b01103cf7ddeeff7b126b",
            "number_of_attendees": 1,
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "requested_for": {
              "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
              "value": "62826bf03710200044e0bfc8bcbe5df1",
              "displayValue": "Abel Tuter",
              "display_value": "Abel Tuter",
              "name": "Abel Tuter",
              "user_name": "abel.tuter",
              "table": "sys_user",
              "avatar": "063e38383730310042106710ce41f13b.iix?t=small",
              "initials": "AT",
              "email": "abel.tuter@example.com",
              "label": "Product Management"
            },
            "number": "WRES0001143",
            "active": true
          },
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "number": "WRES0001143",
          "requested_for": {
            "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
            "value": "62826bf03710200044e0bfc8bcbe5df1",
            "displayValue": "Abel Tuter",
            "display_value": "Abel Tuter",
            "name": "Abel Tuter",
            "user_name": "abel.tuter",
            "table": "sys_user",
            "avatar": "063e38383730310042106710ce41f13b.iix?t=small",
            "initials": "AT",
            "email": "abel.tuter@example.com",
            "label": "Product Management"
          }
        },
        {
          "sys_id": "32f2a98adb7210106c731dcd13961972",
          "name": "B1-03-04",
          "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
          "display_value": "B1-03-04",
          "capacity": 1,
          "label_value": "Workspace/Desk name",
          "email": null,
          "reservable_module": {
            "sys_id": "5db44502dbb650106c731dcd13961937",
            "name": "Desks",
            "title": "Desks",
            "inline_title": "desk"
          },
          "region": {
            "sys_id": "2d626c4edb3650106c731dcd1396194b",
            "display_value": "Europe",
            "active": true
          },
          "site": {
            "sys_id": "b17220cedb3650106c731dcd1396197a",
            "display_value": "Western Europe",
            "active": true
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "active": true
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "active": true,
            "timezone": {
              "value": "Europe/Amsterdam",
              "displayValue": "Europe/Amsterdam"
            }
          },
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "active": true
          },
          "area": {
            "sys_id": "410ff04edb7650106c731dcd13961973",
            "display_value": "Desks C1",
            "active": true
          },
          "reservation": {
            "sys_id": "6a24d0d1533b01103cf7ddeeff7b126e",
            "number_of_attendees": 1,
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "requested_for": {
              "sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
              "value": "a8f98bb0eb32010045e1a5115206fe3a",
              "displayValue": "Abraham Lincoln",
              "display_value": "Abraham Lincoln",
              "name": "Abraham Lincoln",
              "user_name": "abraham.lincoln",
              "table": "sys_user",
              "avatar": null,
              "initials": "AL",
              "email": "abraham.lincoln@example.com",
              "label": ""
            },
            "number": "WRES0001144",
            "active": true
          },
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "number": "WRES0001144",
          "requested_for": {
            "sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
            "value": "a8f98bb0eb32010045e1a5115206fe3a",
            "displayValue": "Abraham Lincoln",
            "display_value": "Abraham Lincoln",
            "name": "Abraham Lincoln",
            "user_name": "abraham.lincoln",
            "table": "sys_user",
            "avatar": null,
            "initials": "AL",
            "email": "abraham.lincoln@example.com",
            "label": ""
          }
        }
      ],
      "reservationAcl": {
        "write": {
          "record": true,
          "fields": {
            "subject": true,
            "sensitivity": true,
            "requested_for": true,
            "number_of_attendees": true,
            "location": true
          },
          "allFields": true
        },
        "read": true
      }
    },
    "children": [
      {
        "sys_id": "2a24d0d1533b01103cf7ddeeff7b126b",
        "number": "WRES0001143",
        "location": {
          "sys_id": "73c2698adb7210106c731dcd13961968",
          "name": "B1-03-03",
          "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
          "display_value": "B1-03-03",
          "capacity": 1,
          "label_value": "Workspace/Desk name",
          "email": null,
          "reservable_module": {
            "sys_id": "5db44502dbb650106c731dcd13961937",
            "name": "Desks",
            "title": "Desks",
            "inline_title": "desk"
          },
          "region": {
            "sys_id": "2d626c4edb3650106c731dcd1396194b",
            "display_value": "Europe",
            "active": true
          },
          "site": {
            "sys_id": "b17220cedb3650106c731dcd1396197a",
            "display_value": "Western Europe",
            "active": true
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "active": true
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "active": true,
            "timezone": {
              "value": "Europe/Amsterdam",
              "displayValue": "Europe/Amsterdam"
            }
          },
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "active": true
          },
          "area": {
            "sys_id": "410ff04edb7650106c731dcd13961973",
            "display_value": "Desks C1",
            "active": true
          },
          "reservation": {
            "sys_id": "2a24d0d1533b01103cf7ddeeff7b126b",
            "number_of_attendees": 1,
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "requested_for": {
              "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
              "name": "Abel Tuter",
              "user_name": "abel.tuter"
            },
            "number": "WRES0001143",
            "active": true
          },
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "number": "WRES0001143",
          "requested_for": {
            "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
            "name": "Abel Tuter",
            "user_name": "abel.tuter"
          }
        },
        "start": "2022-05-30T04:30:00Z",
        "end": "2022-05-30T05:30:00Z",
        "sys_created_on": "2022-05-30T04:19:02Z",
        "sys_updated_on": "2022-05-30T04:19:04Z",
        "source_reservation": {
          "sys_id": "e2245051533b01103cf7ddeeff7b12d6",
          "display_value": "WRES0001142",
          "name": "WRES0001142"
        },
        "check_in_state": {
          "value": "awaiting_check_in",
          "display_value": "Awaiting check-in"
        },
        "external_id": null,
        "external_ical": null,
        "active": true,
        "state": {
          "value": "confirmed",
          "display_value": "Confirmed"
        },
        "sensitivity": {
          "value": "normal",
          "display_value": "Normal"
        },
        "reservation_type": {
          "value": "space",
          "display_value": "Space"
        },
        "reservation_subtype": {
          "value": "single",
          "display_value": "Single"
        },
        "reservation_purpose": {
          "value": "meeting",
          "display_value": "Meeting"
        },
        "attendees": null,
        "number_of_attendees": 1,
        "is_parent": false,
        "subject": "Test#52",
        "virtual_meeting": null,
        "recording_details": [],
        "sync_state": {
          "value": "not_required",
          "display_value": "Synchronization not required"
        },
        "sub_source": {
          "value": "servicenow_workplace_service_delivery",
          "display_value": "ServiceNow Workplace Service Delivery"
        },
        "last_updated_sub_source": {
          "value": "servicenow_workplace_service_delivery",
          "display_value": "ServiceNow Workplace Service Delivery"
        },
        "reservable_module": {
          "sys_id": "5db44502dbb650106c731dcd13961937",
          "name": "Desks",
          "title": "Desks",
          "inline_title": "desk",
          "font_awesome_icon": "fa-desktop",
          "reservable_table": "sn_wsd_core_space",
          "reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
          "short_description": "Reserve a single desks",
          "reservable_type": "location",
          "require_subject": null,
          "require_cancel_notes": false,
          "virtual_meeting_provider": {
            "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
            "display_value": "Template"
          },
          "allow_invitees": null,
          "display_number_of_attendees": null,
          "display_on_behalf_of": "1",
          "display_sensitivity": null,
          "max_days_in_future": "90",
          "allow_whole_day": "1",
          "require_whole_day": null,
          "selection_type": "unit",
          "reservable_container_field": null,
          "reservable_quantity_field": null,
          "apply_to_shift": null,
          "max_occurrences": "90",
          "enable_facet_filter": false,
          "search_limit": 10000,
          "enable_ical_generation": null,
          "enable_group_reservations": "1",
          "enable_browse_near_a_person": "1",
          "enable_browse_by_area": "1",
          "display_value": "Desks",
          "browse_near_a_person_enabled": true,
          "browse_by_area_enabled": true,
          "reservable_columns": [
            "sys_id",
            "external_id",
            "email",
            "name",
            "title",
            "description",
            "image",
            "number",
            "site",
            "campus",
            "building",
            "floor",
            "area",
            "capacity",
            "reservable_quantity",
            "location_type",
            "order",
            "requires_check_in",
            "is_reservable"
          ],
          "layout_mapping": {
            "title": [
              "name"
            ],
            "description": [
              "description"
            ],
            "subtitle": [
              "campus",
              "building",
              "floor",
              "area"
            ],
            "subtitle_asc": [
              "area",
              "floor",
              "building",
              "campus"
            ],
            "image": "image",
            "body": [
              {
                "label": "Capacity",
                "icon": "fa-users",
                "field": "capacity",
                "field_to_display": ""
              },
              {
                "label": "Standard services",
                "icon": "fa-check",
                "field": "standard_services",
                "field_to_display": "name"
              },
              {
                "label": "Reservable purposes",
                "icon": "fa-tags",
                "field": "reservable_purposes",
                "field_to_display": "name"
              }
            ]
          },
          "timeSlots": [
            {
              "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
              "name": "All day",
              "short_description": "8am - 6pm",
              "slot_start": "08:00",
              "slot_end": "18:00"
            },
            {
              "sys_id": "de131cf2dbb5f01038e42b24ca961931",
              "name": "Before noon",
              "short_description": "8am - 12pm",
              "slot_start": "08:00",
              "slot_end": "12:00"
            },
            {
              "sys_id": "6e99ab5ddbb930102e8e853e68961929",
              "name": "After noon",
              "short_description": "1pm - 6pm",
              "slot_start": "13:00",
              "slot_end": "18:00"
            }
          ],
          "buildingSysIds": [
            "9e0364cedb3650106c731dcd1396192b"
          ],
          "reservable_views": [
            {
              "type": "card",
              "label": "Card view",
              "iconClass": "fa-th-large",
              "isDefault": true,
              "order": "1"
            },
            {
              "type": "schedule",
              "label": "Schedule view",
              "iconClass": "fa-calendar-o",
              "isDefault": false,
              "order": "2"
            }
          ],
          "checkin_before_minutes": 30,
          "reservation_paths": [
            {
              "value": "browse_all",
              "displayValue": "Browse all"
            },
            {
              "value": "browse_near_a_person",
              "displayValue": "Browse near a person"
            },
            {
              "value": "browse_by_area",
              "displayValue": "Browse by area"
            }
          ],
          "override_approval_policy": "never_required"
        },
        "notification_recipients": null,
        "notification_custom_message": null,
        "opened_by": {
          "sys_id": "6816f79cc0a8016401c5a33be04be441",
          "value": "6816f79cc0a8016401c5a33be04be441",
          "displayValue": "System Administrator",
          "display_value": "System Administrator",
          "name": "System Administrator",
          "user_name": "admin",
          "table": "sys_user",
          "avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
          "initials": "SA",
          "email": "admin@example.com",
          "label": "System Administrator, Finance"
        },
        "requested_for": {
          "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
          "value": "62826bf03710200044e0bfc8bcbe5df1",
          "displayValue": "Abel Tuter",
          "display_value": "Abel Tuter",
          "name": "Abel Tuter",
          "user_name": "abel.tuter",
          "table": "sys_user",
          "avatar": "063e38383730310042106710ce41f13b.iix?t=small",
          "initials": "AT",
          "email": "abel.tuter@example.com",
          "label": "Product Management"
        },
        "edit_restriction": {
          "value": "fully_restricted",
          "display_value": "Fully restricted"
        },
        "source": {
          "value": "servicenow",
          "display_value": "Workplace Services"
        },
        "source_reservation_requester": {
          "sys_id": "6816f79cc0a8016401c5a33be04be441",
          "name": "System Administrator",
          "user_name": "admin"
        },
        "source_icon": {
          "classNames": "fa fa-calendar-check-o",
          "tooltip": "Reservation is confirmed",
          "imgSrc": ""
        },
        "shift": null,
        "reservationAcl": {
          "write": {
            "record": true,
            "fields": {
              "subject": true,
              "sensitivity": true,
              "requested_for": true,
              "number_of_attendees": true,
              "location": true
            },
            "allFields": true
          },
          "read": true
        }
      },
      {
        "sys_id": "6a24d0d1533b01103cf7ddeeff7b126e",
        "number": "WRES0001144",
        "location": {
          "sys_id": "32f2a98adb7210106c731dcd13961972",
          "name": "B1-03-04",
          "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
          "display_value": "B1-03-04",
          "capacity": 1,
          "label_value": "Workspace/Desk name",
          "email": null,
          "reservable_module": {
            "sys_id": "5db44502dbb650106c731dcd13961937",
            "name": "Desks",
            "title": "Desks",
            "inline_title": "desk"
          },
          "region": {
            "sys_id": "2d626c4edb3650106c731dcd1396194b",
            "display_value": "Europe",
            "active": true
          },
          "site": {
            "sys_id": "b17220cedb3650106c731dcd1396197a",
            "display_value": "Western Europe",
            "active": true
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "active": true
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "active": true,
            "timezone": {
              "value": "Europe/Amsterdam",
              "displayValue": "Europe/Amsterdam"
            }
          },
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "active": true
          },
          "area": {
            "sys_id": "410ff04edb7650106c731dcd13961973",
            "display_value": "Desks C1",
            "active": true
          },
          "reservation": {
            "sys_id": "6a24d0d1533b01103cf7ddeeff7b126e",
            "number_of_attendees": 1,
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "requested_for": {
              "sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
              "name": "Abraham Lincoln",
              "user_name": "abraham.lincoln"
            },
            "number": "WRES0001144",
            "active": true
          },
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "number": "WRES0001144",
          "requested_for": {
            "sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
            "name": "Abraham Lincoln",
            "user_name": "abraham.lincoln"
          }
        },
        "start": "2022-05-30T04:30:00Z",
        "end": "2022-05-30T05:30:00Z",
        "sys_created_on": "2022-05-30T04:19:02Z",
        "sys_updated_on": "2022-05-30T04:19:04Z",
        "source_reservation": {
          "sys_id": "e2245051533b01103cf7ddeeff7b12d6",
          "display_value": "WRES0001142",
          "name": "WRES0001142"
        },
        "check_in_state": {
          "value": "awaiting_check_in",
          "display_value": "Awaiting check-in"
        },
        "external_id": null,
        "external_ical": null,
        "active": true,
        "state": {
          "value": "confirmed",
          "display_value": "Confirmed"
        },
        "sensitivity": {
          "value": "normal",
          "display_value": "Normal"
        },
        "reservation_type": {
          "value": "space",
          "display_value": "Space"
        },
        "reservation_subtype": {
          "value": "single",
          "display_value": "Single"
        },
        "reservation_purpose": {
          "value": "meeting",
          "display_value": "Meeting"
        },
        "attendees": null,
        "number_of_attendees": 1,
        "is_parent": false,
        "subject": "Test#52",
        "virtual_meeting": null,
        "recording_details": [],
        "sync_state": {
          "value": "not_required",
          "display_value": "Synchronization not required"
        },
        "sub_source": {
          "value": "servicenow_workplace_service_delivery",
          "display_value": "ServiceNow Workplace Service Delivery"
        },
        "last_updated_sub_source": {
          "value": "servicenow_workplace_service_delivery",
          "display_value": "ServiceNow Workplace Service Delivery"
        },
        "reservable_module": {
          "sys_id": "5db44502dbb650106c731dcd13961937",
          "name": "Desks",
          "title": "Desks",
          "inline_title": "desk",
          "font_awesome_icon": "fa-desktop",
          "reservable_table": "sn_wsd_core_space",
          "reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
          "short_description": "Reserve a single desks",
          "reservable_type": "location",
          "require_subject": null,
          "require_cancel_notes": false,
          "virtual_meeting_provider": {
            "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
            "display_value": "Template"
          },
          "allow_invitees": null,
          "display_number_of_attendees": null,
          "display_on_behalf_of": "1",
          "display_sensitivity": null,
          "max_days_in_future": "90",
          "allow_whole_day": "1",
          "require_whole_day": null,
          "selection_type": "unit",
          "reservable_container_field": null,
          "reservable_quantity_field": null,
          "apply_to_shift": null,
          "max_occurrences": "90",
          "enable_facet_filter": false,
          "search_limit": 10000,
          "enable_ical_generation": null,
          "enable_group_reservations": "1",
          "enable_browse_near_a_person": "1",
          "enable_browse_by_area": "1",
          "display_value": "Desks",
          "browse_near_a_person_enabled": true,
          "browse_by_area_enabled": true,
          "reservable_columns": [
            "sys_id",
            "external_id",
            "email",
            "name",
            "title",
            "description",
            "image",
            "number",
            "site",
            "campus",
            "building",
            "floor",
            "area",
            "capacity",
            "reservable_quantity",
            "location_type",
            "order",
            "requires_check_in",
            "is_reservable"
          ],
          "layout_mapping": {
            "title": [
              "name"
            ],
            "description": [
              "description"
            ],
            "subtitle": [
              "campus",
              "building",
              "floor",
              "area"
            ],
            "subtitle_asc": [
              "area",
              "floor",
              "building",
              "campus"
            ],
            "image": "image",
            "body": [
              {
                "label": "Capacity",
                "icon": "fa-users",
                "field": "capacity",
                "field_to_display": ""
              },
              {
                "label": "Standard services",
                "icon": "fa-check",
                "field": "standard_services",
                "field_to_display": "name"
              },
              {
                "label": "Reservable purposes",
                "icon": "fa-tags",
                "field": "reservable_purposes",
                "field_to_display": "name"
              }
            ]
          },
          "timeSlots": [
            {
              "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
              "name": "All day",
              "short_description": "8am - 6pm",
              "slot_start": "08:00",
              "slot_end": "18:00"
            },
            {
              "sys_id": "de131cf2dbb5f01038e42b24ca961931",
              "name": "Before noon",
              "short_description": "8am - 12pm",
              "slot_start": "08:00",
              "slot_end": "12:00"
            },
            {
              "sys_id": "6e99ab5ddbb930102e8e853e68961929",
              "name": "After noon",
              "short_description": "1pm - 6pm",
              "slot_start": "13:00",
              "slot_end": "18:00"
            }
          ],
          "buildingSysIds": [
            "9e0364cedb3650106c731dcd1396192b"
          ],
          "reservable_views": [
            {
              "type": "card",
              "label": "Card view",
              "iconClass": "fa-th-large",
              "isDefault": true,
              "order": "1"
            },
            {
              "type": "schedule",
              "label": "Schedule view",
              "iconClass": "fa-calendar-o",
              "isDefault": false,
              "order": "2"
            }
          ],
          "checkin_before_minutes": 30,
          "reservation_paths": [
            {
              "value": "browse_all",
              "displayValue": "Browse all"
            },
            {
              "value": "browse_near_a_person",
              "displayValue": "Browse near a person"
            },
            {
              "value": "browse_by_area",
              "displayValue": "Browse by area"
            }
          ],
          "override_approval_policy": "never_required"
        },
        "notification_recipients": null,
        "notification_custom_message": null,
        "opened_by": {
          "sys_id": "6816f79cc0a8016401c5a33be04be441",
          "value": "6816f79cc0a8016401c5a33be04be441",
          "displayValue": "System Administrator",
          "display_value": "System Administrator",
          "name": "System Administrator",
          "user_name": "admin",
          "table": "sys_user",
          "avatar": "c148e1d13741310042106710ce41f149.iix?t=small",
          "initials": "SA",
          "email": "admin@example.com",
          "label": "System Administrator, Finance"
        },
        "requested_for": {
          "sys_id": "a8f98bb0eb32010045e1a5115206fe3a",
          "value": "a8f98bb0eb32010045e1a5115206fe3a",
          "displayValue": "Abraham Lincoln",
          "display_value": "Abraham Lincoln",
          "name": "Abraham Lincoln",
          "user_name": "abraham.lincoln",
          "table": "sys_user",
          "avatar": null,
          "initials": "AL",
          "email": "abraham.lincoln@example.com",
          "label": ""
        },
        "edit_restriction": {
          "value": "fully_restricted",
          "display_value": "Fully restricted"
        },
        "source": {
          "value": "servicenow",
          "display_value": "Workplace Services"
        },
        "source_reservation_requester": {
          "sys_id": "6816f79cc0a8016401c5a33be04be441",
          "name": "System Administrator",
          "user_name": "admin"
        },
        "source_icon": {
          "classNames": "fa fa-calendar-check-o",
          "tooltip": "Reservation is confirmed",
          "imgSrc": ""
        },
        "shift": null,
        "reservationAcl": {
          "write": {
            "record": true,
            "fields": {
              "subject": true,
              "sensitivity": true,
              "requested_for": true,
              "number_of_attendees": true,
              "location": true
            },
            "allFields": true
          },
          "read": true
        }
      }
    ]
  }
}

WSD Group Reservation - PATCH /api/sn_wsd_rsv/group_reservation/cancel/{id}

Cancels a specified group reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/group_reservation/cancel/{id}

Default URL: /api/sn_wsd_rsv/group_reservation/cancel/{id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 7. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
id
Sys_id of the parent reservation record.

When a group reservation is created, one group parent record and one or more child reservation records are created. Reservation records contain a field called reservation_subtype, that indicates the type of reservation record. For group parent records, this field is set to "Group parent" to indicate that it is a group parent record. For child records, this field is set to "Single".

Within a child record, the sys_id of the associated parent reservation record is in the source_reservation field.

Data type: String

Table: Workplace Reservation [sn_wsd_rsv_reservation]
Table 8. Query parameters
Name Description
None
Table 9. Request body parameters
Name Description
cancel_notes Reason for cancelling the reservation.

Data type: String

Default: "Canceled reservation via Group cancel"

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 10. Request headers
Header Description
Accept Data format of the request body. Supported types: application/json, application/xml or, text/xml.

Default: application/json
Content-Type Data format of the request body. Only supports application/json.
Table 11. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters

Example: cURL request

The following code example shows how to cancel a group reservation.

curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/cancel/22c1aee353af01103cf7ddeeff7b12d5" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"cancel_notes\":\"Need to postpone until next quarter\"
}" \
--user 'username':'password'

Return results:

{
  "result": {
    "success": true,
    "canceledReservations": [
      "6ec1aee353af01103cf7ddeeff7b12d8",
      "aac1aee353af01103cf7ddeeff7b12db"
    ],
    "failedChildMeetings": [],
    "cancelledParent": true,
    "allChildrenCanceled": true,
    "msg": "",
    "user_msg": "",
    "parent": "22c1aee353af01103cf7ddeeff7b12d5"
  }
}

WSD Group Reservation - PATCH /api/sn_wsd_rsv/group_reservation/update/{id}

Updates a specified group reservation.

You can update the following reservation parameters:
  • Subject
  • Start date and time
  • End date and time
  • Shift associated with the reservation
  • Workplace location of any child reservation
Note: You must specify at least one of these parameters in the request body of the endpoint call. Parameters that are not passed in are not modified in the associated records.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/group_reservation/update/{id}

Default URL: /api/sn_wsd_rsv/group_reservation/update/{id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 13. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
id
Sys_id of the parent reservation record.

When a group reservation is created, one group parent record and one or more child reservation records are created. Reservation records contain a field called reservation_subtype, that indicates the type of reservation record. For group parent records, this field is set to "Group parent" to indicate that it is a group parent record. For child records, this field is set to "Single".

Within a child record, the sys_id of the associated parent reservation record is in the source_reservation field.

Data type: String

Table: Workplace Reservation [sn_wsd_rsv_reservation]
Table 14. Query parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 16. Request headers
Header Description
Accept Data format of the request body. Supported types: application/json, application/xml or, text/xml.

Default: application/json
Content-Type Data format of the request body. Only supports application/json.
Table 17. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters

Example: cURL request

The following example shows how to call this endpoint to update a group reservation.

curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/update/b84e218a87586550cfaa99b73cbb35ec" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
    \"subject\": \"Test-123\",
    \"reservation_purpose\": \"meeting\",
    \"timezone\": \"US/Pacific\",
    \"children\": [
        {
            \"location\": \"6a11a94adb7210106c731dcd1396194e\",
            \"requested_for\": \"62826bf03710200044e0bfc8bcbe5df1\",
            \"is_private\": false
        },
        {
            \"location\": \"9841e94adb7210106c731dcd13961914\",
            \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
            \"is_private\": false
        }
    ],
    \"start\": \"2023-02-12T11:30:00Z\",
    \"end\": \"2023-02-12T12:30:00Z\"
}" \

Return results:

{
  "result": {
    "parent": "b84e218a87586550cfaa99b73cbb35ec",
    "success": true,
    "successfulReservations": [
      {
        "operation": "create",
        "sys_id": "7b9e658a87586550cfaa99b73cbb357d",
        "msg": "",
        "user_msg": null,
        "location": "6a11a94adb7210106c731dcd1396194e"
      },
      {
        "operation": "create",
        "sys_id": "3b9e658a87586550cfaa99b73cbb3580",
        "msg": "",
        "user_msg": null,
        "location": "9841e94adb7210106c731dcd13961914"
      }
    ],
    "unSuccessfulReservations": []
  }
}

WSD Group Reservation - POST /api/sn_wsd_rsv/group_reservation/add

Creates a group reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/group_reservation/add

Default URL: /api/sn_wsd_rsv/group_reservation/add

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 19. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 20. Query parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 22. Request headers
Header Description
Accept Data format of the request body. Supported types: application/json, application/xml or, text/xml.

Default: application/json
Content-Type Data format of the request body. Only supports application/json.
Table 23. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Response body parameters

Example: cURL request

The following code example shows how to use this endpoint to create a group reservations.

curl "http://instance.servicenow.com/api/sn_wsd_rsv/group_reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
    \"subject\": \"Test-123\",
    \"reservation_purpose\": \"meeting\",
    \"timezone\": \"US/Pacific\",
    \"children\": [
        {
            \"location\": \"6a11a94adb7210106c731dcd1396194e\",
            \"requested_for\": \"62826bf03710200044e0bfc8bcbe5df1\",
            \"is_private\": false
        },
        {
            \"location\": \"9841e94adb7210106c731dcd13961914\",
            \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
            \"is_private\": false
        }
    ],
    \"start\": \"2023-01-12T11:30:00Z\",
    \"end\": \"2023-01-12T12:30:00Z\"
}" \
--user 'username':'password'

Return results:

{
  "result": {
    "parent": "b84e218a87586550cfaa99b73cbb35ec",
    "success": true,
    "created_children": [
      {
        "sys_id": "7c4e218a87586550cfaa99b73cbb35ee",
        "location": "6a11a94adb7210106c731dcd1396194e",
        "requested_for": "62826bf03710200044e0bfc8bcbe5df1"
      },
      {
        "sys_id": "3c4e218a87586550cfaa99b73cbb35f1",
        "location": "9841e94adb7210106c731dcd13961914",
        "requested_for": "6816f79cc0a8016401c5a33be04be441"
      }
    ],
    "failed_children": [],
    "user_msg": "",
    "msg": ""
  }
}