WSD Extra Service API
-
- UpdatedJan 30, 2025
- 8 minutes to read
- Yokohama
- API reference
The Workplace Service Delivery (WSD) Extra Service API provides endpoints to retrieve extra services, such as location layouts and standard services of a workplace location.
To access this API, the caller must have the sn_wsd_core.workplace_user role.
This API runs in the sn_wsd_rsv
namespace. To access this API the Workplace
Reservation Management (sn_wsd_rsv) plugin must be activated.
For additional information on Workplace Reservation Management, see Workplace Reservation Management.
WSD Extra Service Request - PATCH /api/sn_wsd_rsv/wsd_extra_service_request/reservation/{sys_id}
Returns the extra service requests that are associated to a single reservation.
URL format
Versioned URL: /api/sn_wsd_rsv/{api_version}/wsd_extra_service_request/reservation/{sys_id}
Default URL: /api/sn_wsd_rsv/wsd_extra_service_request/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 record for which to return the extra service request details. Data type: String Table: Workplace Reservation [sn_wsd_rsv_reservation] |
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
This code example shows how to request the details of the extra services or workplace service items for a reservation.
Return results:
WSD Extra Service Request - PATCH /api/sn_wsd_rsv/wsd_extra_service_request/submit
Adds an new or updates an existing extra service request to a specified single reservation.
URL format
Versioned URL: /api/sn_wsd_rsv/{api_version}/wsd_extra_service_request/submit
Default URL: /api/sn_wsd_rsv/wsd_extra_service_request/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
Example: cURL request
The following code example shows how to add an extra service item request to a reservation.
Return results: