<access-service>/api/v1/organisations/{organisationId}/removalRequest

URL structure

https://access-service.xy-company.com/api/v1/organisations/{organisationId}/removalRequest

where {organisationId} is the ID of an organisation.

Supported methods and overview

• POST - initiates a request to remove an organisation (specified by organisationId) configured on the Covata Platform.
• DELETE - cancels or declines an existing request to remove an organisation (specified by organisationId).

Note: The DELETE method takes no parameters.

Detailed description

This API endpoint serves a number of purposes:

• Initiates a request to remove an organisation (specified by organisationId) configured on the Covata Platform.
• Either cancels an existing request (initiated by the same SafeShare administrator) to remove an organisation specified by organisationId, or declines such an existing request (i.e. initiated by another SafeShare administrator).

Tip: To determine if an organisation has an existing request for its removal, use the <access-service>/api/v1/organisations API endpoint to retrieve information about organisations configured on the Covata Platform and if the required organisation's organisationRemovalRequest member is not null and contains sub-members, then the organisation has an existing request for its removal.

Supported roles

This API endpoint supports the following Covata user roles (as described in the SafeShare Administrator's Guide):

• SafeShare administrator

The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required POST-request parameters

The following required parameters must be sent in the body of the POST request, each as individual members of a JSON object:

• notificationEnabled - A boolean value specifying whether (true) or not (false) the contact person of the organisation (specified by organisationId) will be sent an email notification informing them that a SafeShare administrator had initiated a request to remove their organisation from the Covata Platform.
  Note: If the Days to action organisation removal property value (accessible through the <access-service>/api/v1/config/theme/orgRemovalActionDays API endpoint) is cleared, then no email notification is sent, regardless of the notificationEnabled property value submitted in the request. Since this property is required, however, if the Days to action organisation removal property value is cleared/not set, it is recommended submitting this notificationEnabled property's value as false to ensure correct system behavior.
  Example (request):

  {
    "notificationEnabled": "true"
  }

Returns

If the POST request succeeded, then an HTTP response status 201 Created is returned.

If the DELETE request succeeded, then an HTTP response status 204 No Content is returned.