List Notification Preference REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:47:59 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:47:59

GET api.ashx/v2/notificationpreferences.{json|xml}

LIST notification preferences.

Scopes

Notifications › Read Preferences notifications.preferences.readonly

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/notificationpreferences.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "Preferences": {
    "Url": "url",
    "Preferences": [
      {
        "NotificationTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "DistributionTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "IsEnabled": true
      },
      {
        "NotificationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
        "DistributionTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
        "IsEnabled": true
      }
    ]
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Preferences>
    <Url>url</Url>
    <Preferences>
      <RestNotificationPreference>
        <NotificationTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</NotificationTypeId>
        <DistributionTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</DistributionTypeId>
        <IsEnabled>true</IsEnabled>
      </RestNotificationPreference>
      <RestNotificationPreference>
        <NotificationTypeId>fe65240b-044c-4292-9946-f10e0361ecff</NotificationTypeId>
        <DistributionTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</DistributionTypeId>
        <IsEnabled>true</IsEnabled>
      </RestNotificationPreference>
    </Preferences>
  </Preferences>
</Response>