WSD Reservation Invitees API
-
- UpdatedJan 30, 2025
- 8 minutes to read
- Yokohama
- API reference
The Workplace Service Delivery (WSD) Reservation Invitees API provides endpoints to add invitees to reservations, fetch invitees of a reservation, and reassign invitees of a reservation.
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.
This API runs in the sn_wsd_rsv
namespace.
For additional information on Workplace Reservation Management, see Workplace Reservation Management.
WSD Reservation Invitees - GET /api/sn_wsd_rsv/wsd_reservation_invitees/reservation/{sys_id}
Retrieves details about the invitees associated with a specified reservation.
URL format
Versioned URL: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reservation/{sys_id}
Default URL: /api/sn_wsd_rsv/reservation/{sys_id}
Supported request 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 |
sys_id | Sys_id of the reservation for which to return the invitee details. Data type: String |
Name | Description |
---|---|
None |
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.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
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 retrieve the invitees for a reservation.
Return results:
WSD Reservation Invitees - POST /api/sn_wsd_rsv/wsd_reservation_invitees/reassign
Reassigns the specified invitees from one reservation to another.
URL format
Versioned URL: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reassign
Default URL: /api/sn_wsd_rsv/wsd_reservation_invitees/reassign
Supported request 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 |
Name | Description |
---|---|
None |
Name | Description |
---|---|
reservationId | Required. Sys_id of the reservation for which to reassign the invitees. Data type: String Table: Workplace Reservation [sn_wsd_rsv_reservation] |
reservationInvitees | List of invitees to reassign to the reservation identified in the reservationId parameter. This removes the specified invitees from an earlier reservation in which they were present as per the reservation invitee table and moves them to this reservation. Data type: Array of Strings Table: Reservation Invitee [sn_wsd_rsv_m2m_reservation_invitee] |
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.
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. |
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 invitee reassignment. Data type: Object |
result.reservationInviteeIds | List of sys_ids of the reservation invitees that were re-assigned to the
specified reservation. Data type: Array of Strings |
result.success | Flag that indicates whether the invitees were reassigned to the reservation. Possible values:
Data type: Boolean |
Example: cURL request
The following code example shows how to reassign invitees to a reservation.
Return results:
WSD Reservation Invitees - POST /api/sn_wsd_rsv/wsd_reservation_invitees/submit
Adds the specified invitees to a specified reservation.
URL format
Versioned URL: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/submit
Default URL: /api/sn_wsd_rsv/wsd_reservation_invitees/submit
Supported request 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 |
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.
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. |
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 | Result of adding the invitees to the reservation. Data type: Object |
result.reservationId | Sys_id of the reservation to which the invitee was added. Data type: String |
result.success | Flag that indicates whether the invitees were added to the
reservation. Possible values:
Data type: Boolean |
Example: cURL request
The following code example shows how to add both a visitor and an employee to a reservation.
Return results: