Skip to main content

​
URL structure

​
Supported methods and overview

  • GET - used to retrieve information about the currently authenticated Covata user’s* notification preferences.
  • PUT - used to modify the currently authenticated Covata user’s notification preferences.
The GET method takes no parameters.

​
Detailed description

This API endpoint serves a number of purposes:
  • Retrieves information about the currently authenticated Covata user’s* notification preferences (as a list that provides details about all other available notification preference options).
  • Modifies the currently authenticated Covata user’s notification preferences.
    Note: These settings can also be modified through the My Account feature of the Safe Share web application.

​
Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator’s Guide): The Covata Platform’s resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

​
Required headers

The appropriate access token as the Bearer token:
  • Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6
The following header is required if the body of the request has a JSON object:
  • Content-Type: application/json

​
Optional parameters

The following optional parameters can also be sent in the body of the PUT request, each as individual members of a JSON object:
  • code - item, daily, weekly or none. Example ():

​
Returns

A JSON-formatted response containing the following members:
  • notificationPreferences - .
    • name - .
    • code - .
    • selected - .
    Example (response from …):
* The currently authenticated user is determined by the access token passed in the header of requests to this endpoint.