NFK Web Services GET and SEND (SCE)

As part of Simplified Campus Experience (SCE) features, two web services were created for Notifications Framework – GET and SEND.

Refer to the Simplified Campus Experience documentation in My Oracle Support (ID 1600569.1)

SCC_GET_NOTIFICATIONS (primarily for the retrieval of Alerts and Worklist Items, but can also be used to retrieve Item detail for Email and SMS).
SCC_SEND_NOTIFICATIONS (primarily for sending Emails and SMS from devices that do not contain native support, but can also be used to send Alerts and Worklist Items).

These service operations have been created under a common existing service SCC_NOTIFICATIONS. The schema for the GET and SEND request messages are shown below.

SCC_GET_NOTIF_REQ

The request message gives flexibility to retrieve from any channel type using generic filtering criteria from the Item or to search using specific Item keys if they are known. All notifications for the logged-in user are fetched by the service. Further details on the tag items are mentioned below.

<?xml version="1.0"?>
<SCC_GET_NOTIF_REQ xmlns="http://xmlns.oracle.com/Enterprise/services">
  <EMPLID></EMPLID>
  <SCC_NTFREQ_ID></SCC_NTFREQ_ID>
  <SCC_NTF_CON_ID></SCC_NTF_CON_ID>
  <SCC_NTFREQ_TYPE></SCC_NTFREQ_TYPE>
  <SCC_NTFREQ_ITMTAG1></SCC_NTFREQ_ITMTAG1>
  <SCC_NTFREQ_ITMTAG2></SCC_NTFREQ_ITMTAG2>
  <SCC_NTFREQ_ITMTAG3></SCC_NTFREQ_ITMTAG3>
  <SCC_NTFREQ_ITMTAG4></SCC_NTFREQ_ITMTAG4>
  <SCC_NTFREQ_ITM_STS></SCC_NTFREQ_ITM_STS>
  <SCC_NTFREQ_ITM_TAG></SCC_NTFREQ_ITM_TAG>
  <SCC_NTF_DATE_FROM></SCC_NTF_DATE_FROM>
  <SCC_NTF_DATE_TO></SCC_NTF_DATE_TO>
  <SCC_NTFREQ_SUB_STS></SCC_NTFREQ_SUB_STS>
  <SCC_NTFREQ_DTL_SEQ></SCC_NTFREQ_DTL_SEQ>
  <SCC_NTFREQ_ITM_SEQ></SCC_NTFREQ_ITM_SEQ>
  <SCC_NTF_AUDCE></SCC_NTF_AUDCE>
</SCC_GET_NOTIF_REQ>

Tag Item	Tag Item Details
EMPLID	The EMPLID is always populated with the logged-in user’s EMPLID as it supports only self-service users.
SCC_NTFREQ_ID	When mentioned, the Notification Request ID fetches items having the same value for Request ID as what has been passed. This is essentially a filter.
SCC_NTFREQ_TYPE	Possible values are EML, SMS, WKL and ALT. When supplied, this parameter fetches only notifications of the given type for the particular EMPLID.
SCC_NTFREQ_ITM_TAG ... SCC_NTFREQ_ITMTAG4	This fetches items based on the tags associated with them.
SCC_NTFREQ_ITM_STS, SCC_NTFREQ_SUB_STS	This filters items based on their Status and Sub-Status. Items with a status such as ERROR, or sub-status such as DELETED/TIMEDOUT are not qualified for selection.
SCC_NTFREQ_DTL_SEQ, SCC_NTFREQ_ITM_SEQ	This, when combined with the notification request ID, focuses on a single item, which is then fetched by the get service.
SCC_NTF_DATE_FROM, SCC_NTF_DATE_TO	When values are given for from and to dates, all the SMS/EML notifications created within the given range are retrieved. For ALT/WKL all items which are active in the given date range are retrieved. This also includes all open-ended items.
SCC_NTF_AUDCE	It can have two possible values currently as mentioned above - ST/NA. When ST value is passed, only the Announcement Notifications is returned by the service. In case no value (is treated as NA) or NA value is passed, all notifications – EML/SMS/WKL/ALT – are fetched along with the announcement notifications.

This is a sample response message:

<?xml version="1.0"?>
<SCC_GET_NOTIF_RESP xmlns="http://xmlns.oracle.com/Enterprise/services">
    <NTK_ITEM>
      <SCC_NTFREQ_ID>282</SCC_NTFREQ_ID>
      <SCC_NTFREQ_DTL_SEQ>1</SCC_NTFREQ_DTL_SEQ>
      <SCC_NTFREQ_ITM_SEQ>1</SCC_NTFREQ_ITM_SEQ>
      <EMPLID>SR0448</EMPLID>
      <SCC_NTF_CON_ID>SCC_NTF_CON_20130512074705</SCC_NTF_CON_ID>
      <SCC_NTF_DATE_FROM>2013-07-08</SCC_NTF_DATE_FROM>
      <SCC_NTF_DATE_TO></SCC_NTF_DATE_TO>
      <SCC_NTFREQ_TYPE>ALT</SCC_NTFREQ_TYPE>
      <SCC_NTFREQ_TMPLTID>SCC_NTF_TMP_20130512074210</SCC_NTFREQ_TMPLTID>
      <SCC_NTFREQ_SUBJECT>Test Template for ALERT Notifications</SCC_NTFREQ_SUBJECT>
      <SCC_NTFREQ_IMPTNCE>2</SCC_NTFREQ_IMPTNCE>
      <SCC_NTFREQ_ITM_STS>S</SCC_NTFREQ_ITM_STS>
      <SCC_NTFREQ_SUB_STS>U</SCC_NTFREQ_SUB_STS>
      <SCC_NTFREQ_ITM_TAG>VISWA</SCC_NTFREQ_ITM_TAG>
      <SCC_NTFREQ_ITMTAG1>TAG1</SCC_NTFREQ_ITMTAG1>
      <SCC_NTFREQ_ITMTAG2>TAG2</SCC_NTFREQ_ITMTAG2>
      <SCC_NTFREQ_ITMTAG3>TAG3</SCC_NTFREQ_ITMTAG3>
      <SCC_NTFREQ_ITMTAG4>TAG4</SCC_NTFREQ_ITMTAG4>
      <SCC_ROW_ADD_DTTM>07/30/2013 17:19:56.000000</SCC_ROW_ADD_DTTM>
      <SCC_NTFREQ_MSGTEXT>This is a test template for ALERT Notifications.

      Value 1 - Test1
      Value 2 - tst2
      Value 5 - tst3
      </SCC_NTFREQ_MSGTEXT>
      <SCC_NTF_AUDCE>NA</SCC_NTF_AUDCE>
    </NTK_ITEM>
</SCC_GET_NOTIF_RESP>

Note: If a SOAP service request XSD contains the “languageCd” parameter, then the service is enabled for National Language Support (NLS) and an ISO Locale value needs to be passed as the languageCd variable. Valid values can be found by navigating to PeopleTools > Utilities > International > Languages.

SCC_SEND_NOTIF_REQ

The Send request is comprised of the Item detail, a parameter map of tokens, and optional Base64 attachments (for the email channel only).

<?xml version="1.0"?>
<SCC_SEND_NOTIF_REQ xmlns="http://xmlns.oracle.com/Enterprise/services">
    <EMPLID>SR0451</EMPLID>
    <SCC_NTF_CON_ID></SCC_NTF_CON_ID>
    <SCC_NTF_DATE_FROM></SCC_NTF_DATE_FROM>
    <SCC_NTF_DATE_TO></SCC_NTF_DATE_TO>
    <SCC_NTFREQ_TMPLTID>SCC_NTF_TMP_20130404201255</SCC_NTFREQ_TMPLTID>
    <SCC_NTFREQ_IMPTNCE></SCC_NTFREQ_IMPTNCE>
    <SCC_NTFREQ_ITM_TAG>TEST</SCC_NTFREQ_ITM_TAG>
    <SCC_NTFREQ_ITMTAG1></SCC_NTFREQ_ITMTAG1>
    <SCC_NTFREQ_ITMTAG2></SCC_NTFREQ_ITMTAG2>
    <SCC_NTFREQ_ITMTAG3></SCC_NTFREQ_ITMTAG3>
    <SCC_NTFREQ_ITMTAG4></SCC_NTFREQ_ITMTAG4>
    <PARAMETER_MAP>
       <PARAMETER>
          <SCC_NTFREQ_DAT_KEY>%1</SCC_NTFREQ_DAT_KEY>
          <SCC_NTFREQ_DAT_VAL>This is a Test email.</SCC_NTFREQ_DAT_VAL>
       </PARAMETER>
       <PARAMETER>
          <SCC_NTFREQ_DAT_KEY>%2</SCC_NTFREQ_DAT_KEY>
          <SCC_NTFREQ_DAT_VAL>From the friendly NFK</SCC_NTFREQ_DAT_VAL>
       </PARAMETER>
    </PARAMETER_MAP>
    <ATTACHMENTS>
       <ATTACHMENT>
          <fileName>Scooby.jpg</fileName>
          <Base64Data>/9j/4AAQSkZJRgABAQEAYAB</Base64Data>
       </ATTACHMENT>
    </ATTACHMENTS>
 </SCC_SEND_NOTIF_REQ>

The Send request must have the following parameters populated – EMPLID and SCC_NTFREQ_TMPLTID.

Other than the parameters already explained above, the send request also holds the template parameters - SCC_NTFREQ_DAT_KEY and SCC_NTFREQ_DAT_VAL. This holds the value of the bind variables defined in the generic template.

If the notification web service results in a successful send, an empty XML is returned as response.

NFK Web Services GET and SEND (SCE)

GET Request

SCC_GET_NOTIF_REQ

SEND Request

SCC_SEND_NOTIF_REQ