Retrieving one or more notifiers using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

REST Syntax

Click to view all REST Resources

/REST/Notifier/ GET – Retrieve one or more Notifier resources.

HTTP Action — GET

URIs:

Get One Notifier — https://api.dynect.net/REST/Notifier/<notifier_id>/
Get Notifiers — https://api.dynect.net/REST/Notifier/

Arguments:

Get One Notifier: Retrieves the details of the specified Notifier.

Get Notifiers: Retrieves a list of Notifier resources.

  • string label — The label used to identify the Notifier object. Can be wildcarded.
    NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
  • string format — Search for type of recipient
  • string recipient — Search on the recipient email or contact.
  • string recipient_active — Search for active or inactive recipients.
  • string service_class — Notify when the monitored object has recovered. Defaults to ‘true’.
  • string service_id — service_id of the service_class item to search for. MUST be paired with service_class.
  • string service_active — Search for active or inactive services.
  • string active — Search for active or inactive notifiers
Response:

Get One Notifier — Click for More Info

Get Notifiers: Array of Individual Notifier resources.

Dyn Logo

SOAP Syntax

Click to view all SOAP Commands

GetOneNotifier — Retrieve the identified Notifier.

GetNotifiers — Retrieve Notifiers based on the given criteria.

Arguments:

GetOneNotifier:

  • notifier_id — Required. Identifier for the Notifier.
  • token — Required. Session identifier.

GetNotifiers — Click for More Info

Response:
GetOneNotifier — Click for More Info

GetNotifiers — Click for More Info

Example Requests:

GetOneNotifier — Click for More Info

GetNotifiers — Click for More Info