Display the notification settings for the current user (GET)

Edit online

Description

URL

scheme://domain:port/platform/ws/notifications/settings

Description

Displays the notification settings for the current user.

HTTP Method

GET

Parameters

None

Request

Request

Request Information

Method

GET

Request-URI

/platform/ws/notifications/settings

Request-Header

Name

Value

Accept

application/xml or application/json

Message-Body

Empty

Response

Response Code

  • 200 Successful: Request was successful.
  • 400 Bad Request: The input is not valid.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 500 Internal Server Error: Exception occurred

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

 Success Message 
<UserNotificationSettings>
    <UserName>%s</UserName>
    <AppParam>
        <defaultValue>%s</defaultValue>
        <id>%s</id>
        <label>%s </label>
        <mandatory>%s</mandatory>
        <type>%s</type>
        <value>%s</value>
    </AppParam>
      …
</UserNotificationSettings>
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/jobs/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example: 

# Request
GET /platform/webservice/notifications/settings HTTP/1.1
Host: www.example.org
cookie: platform_token=%s
Content-Type: application/xml
Accept: application/xml


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<UserNotificationSettings>
    <UserName>lsfadmin</UserName>
    <UserEmail>lsfadmin@example.org</UserEmail>
    <AppParam>
        <defaultValue>Y</defaultValue>
        <id>NOTIFY_ENABLE</id>
        <label>Enable notifications</label>
        <mandatory>-</mandatory>
        <type></type>
        <value>Y</value>
    </AppParam>
    <AppParam>
        <defaultValue>START,END,SUSPENDED,EXIT</defaultValue>
        <id>NOTIFY_EVENTS</id>
        <label>Workload events</label>
        <mandatory>-</mandatory>
        <type></type>
        <value>START,END,SUSPENDED,EXIT</value>
    </AppParam>
    <AppParam>
        <defaultValue>BROWSER,EMAIL</defaultValue>
        <id>NOTIFY_CHANNELS</id>
        <label>Notification channels</label>
        <mandatory>-</mandatory>
        <type></type>
        <value>BROWSER,EMAIL</value>
    </AppParam>
</UserNotificationSettings>

# Response
200 Successful