Web Services Reference for Oracle Billing Insight > Examples of Web Services > Examples of the Notifications Web Service >

Example of Getting a List of Notification Choices

This example shows you how to use the notification Web service to get a list of notification choices.

Operation

Use the following operation to get a node ID using the unique link target URI:

GET /notifications

Sample URL

The following is a sample URL for this Web service example:

http://myhost.example.com:7017/rs/api/v2/notifications

XML Response

The following is an example of the XML response:

<notificationChoices>
<choice>
<id>newStmtAvailable</id>
<description>My bill is ready for viewing</description>
<email>
<title>Send email if my bill is ready for viewing</title>
<selected>true</selected>
</email>
<sms>
<title>Send SMS if my bill is ready for viewing</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>newStmtAvailablePDF</id>
<description>My bill summary is ready via PDF</description>
<email>
<title>Send email if my bill summary is ready via PDF</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my bill summary is ready via PDF</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>paymentAccountCreateDelete</id>
<description>My payment account has been created,deleted or updated
</description>
<email>
<title>Send email if my payment account has been created,deleted or updated
</title>
<selected>true</selected>
</email>
<sms>
<title>Send SMS if my payment account has been created,deleted or updated
</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>paymentDueXDays</id>
<description>My payment is due in</description>
<email>
<title>Send email if my payment is due in</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my payment is due in</title>
<selected>false</selected>
</sms>
<parameters>
<parameter>
<name>numDaysBeforeDueDate</name>
<value>5</value>
</parameter>
</parameters>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>instantPayment</id>
<description>My payment was submitted, modified or deleted</description>
<email>
<title>Send email if my payment was submitted</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my payment was submitted</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>recurPaymentSetupModify</id>
<description>My recurring payment is setup, modified or deleted</description>
<email>
<title>Send email if my recurring payment is setup or modified</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my recurring payment is setup or modified</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>recurPaymentThresholdExceed</id>
<description>My recurring payment is less than the total amount due
(threshold exceeded)</description>
<email>
<title>Send email if my recurring payment is less than the total amount due
(threshold exceeded)</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my recurring payment is less than the total amount due
(threshold exceeded)</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>paymentPosts</id>
<description>My payment was made successfully</description>
<email>
<title>Send email if my payment was made successfully</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my payment was made successfully</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>paymentFailed</id>
<description>My payment failed</description>
<email>
<title>Send email if my payment failed</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my payment failed</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>creditCardExpiration</id>
<description>My credit card is about to expire</description>
<email>
<title>Send email if my credit card is about to expire</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my credit card is about to expire</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>batchReportReady</id>
<description>My batch report is ready</description>
<email>
<title>Send email if my batch report is ready</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my batch report is ready</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
<choice>
<id>batchReportRequestExpiry</id>
<description>My batch report request is expired</description>
<email>
<title>Send email if my batch report request is expired</title>
<selected>false</selected>
</email>
<sms>
<title>Send SMS if my batch report is expired</title>
<selected>false</selected>
</sms>
<enableSMS>Y</enableSMS>
</choice>
</notificationChoices>