NFK Web Services for Events

As part of Push Notifications, the following rest web service operations were created for the Notifications Framework:

SCC_NTF_GET_EVENTS_R_POST (primarily for the retrieval of events list along with read/unread/total events count)
SCC_NTF_UPDATE_EVENTS_R_POST (primarily for updating the event status which returns the latest read/unread/total events count)

These service operations have been created under a common existing service – SCC_NOTIFICATIONS_R.

SCC_NTF_GET_EVENTS_REQ (request message for SCC_NTF_GET_EVENTS_R_POST)

<?xml version="1.0"?>
<SCC_NTF_GET_EVENTS_REQ_R>
	<NUM_PAST_DAYS>7</NUM_PAST_DAYS>
	<INCLUDE_EVENTS>N</INCLUDE_EVENTS>
</SCC_NTF_GET_EVENTS_REQ_R>

Tag Item	Tag Item Details
NUM_PAST_DAYS	Past number of days to retrieve events.
INCLUDE_EVENTS	“Y” – includes events in the response along with read/unread/total events count. “N” – only read/unread/total events count in the response.

SCC_NTF_GET_EVENTS_RESP (response message for SCC_NTF_GET_EVENTS_R_POST)

<?xml version="1.0"?>
<SCC_NTF_GET_EVENTS_RESP xmlns="http://xmlns.oracle.com/Enterprise/HCM/services">
   <TOTAL_EVENTS_COUNT>12</TOTAL_EVENTS_COUNT>
   <READ_EVENTS_COUNT>8</READ_EVENTS_COUNT>
   <UNREAD_EVENTS_COUNT>4</UNREAD_EVENTS_COUNT>
   <EVENTS>
      <SCC_NTF_EVENT>
         <SCC_NTFEVT_REQ_ID>487</SCC_NTFEVT_REQ_ID>
         <EMPLID>SR12030</EMPLID>
         <SCC_NTFEVT_STATUS>R</SCC_NTFEVT_STATUS>
         <SCC_NTFEVT_STARTDT>03/21/2014 10:04:43.000000</SCC_NTFEVT_STARTDT>
         <SCC_NTFEVT_MESSAGE>Your final grade for SOC 103.2 has been posted.</SCC_NTFEVT_MESSAGE>
         <DATA>
            <SCC_NTFEVT_DATA>
               <SCC_NTFEVT_DAT_KEY>CAREER</SCC_NTFEVT_DAT_KEY>
               <SCC_NTFEVT_DAT_VAL>UGRD</SCC_NTFEVT_DAT_VAL>
            </SCC_NTFEVT_DATA>
            <SCC_NTFEVT_DATA>
               <SCC_NTFEVT_DAT_KEY>EVENT_TYPE</SCC_NTFEVT_DAT_KEY>
               <SCC_NTFEVT_DAT_VAL>FINAL_GRADE_POSTED</SCC_NTFEVT_DAT_VAL>
            </SCC_NTFEVT_DATA>
            <SCC_NTFEVT_DATA>
               <SCC_NTFEVT_DAT_KEY>GOTO</SCC_NTFEVT_DAT_KEY>
               <SCC_NTFEVT_DAT_VAL>Grades</SCC_NTFEVT_DAT_VAL>
            </SCC_NTFEVT_DATA>
            <SCC_NTFEVT_DATA>
               <SCC_NTFEVT_DAT_KEY>INST</SCC_NTFEVT_DAT_KEY>
               <SCC_NTFEVT_DAT_VAL>PSUNV</SCC_NTFEVT_DAT_VAL>
            </SCC_NTFEVT_DATA>
            <SCC_NTFEVT_DATA>
               <SCC_NTFEVT_DAT_KEY>TERM</SCC_NTFEVT_DAT_KEY>
               <SCC_NTFEVT_DAT_VAL>0710</SCC_NTFEVT_DAT_VAL>
            </SCC_NTFEVT_DATA>
         </DATA>
      </SCC_NTF_EVENT>    </EVENTS>
</SCC_NTF_GET_EVENTS_RESP>

Tag Item	Tag Item Details
TOTAL_EVENTS_COUNT	Total number of events from NUM_PAST_DAYS sent in the request.
READ_EVENTS_COUNT	Total number of read events from NUM_PAST_DAYS sent in the request.
UNREAD_EVENTS_COUNT	Total number of unread events from NUM_PAST_DAYS sent in the request.
SCC_NTFEVT_REQ_ID	Event request ID which uniquely identifies an event.
EMPLID	Employee ID.
SCC_NTFEVT_STATUS	Status of the event. “R” - Read “U” - Unread .
SCC_NTFEVT_STARTDT	Event occurred datetime.
SCC_NTFEVT_MESSAGE	Event Message
SCC_NTFEVT_DAT_KEY	Key for data map (key-value pairs).
SCC_NTFEVT_DAT_VAL	Value for data map (key-value pairs).

SCC_NTF_UPDATE_EVENTS_REQ (request message for SCC_NTF_UPDATE_EVENTS_R_POST)

<?xml version="1.0"?>
<SCC_NTF_UPDATE_EVENTS_REQ>
	<NUM_PAST_DAYS>7</NUM_PAST_DAYS>
	<EVENTS>
	<SCC_NTF_EVENT>	
		<SCC_NTFEVT_REQ_ID>216</SCC_NTFEVT_REQ_ID>
		<SCC_NTFEVT_STATUS>R</SCC_NTFEVT_STATUS>
	</SCC_NTF_EVENT>
	</EVENTS>
</SCC_NTF_UPDATE_EVENTS_REQ>

Tag Item	Tag Item Details
NUM_PAST_DAYS	Past number of days to retrieve events.
SCC_NTFEVT_REQ_ID	Event request ID for which status has to be updated.
SCC_NTFEVT_STATUS	Status of the event to be updated. “R” - Read “U” - Unread.

SCC_NTF_UPDATE_EVENTS_RESP (response message for SCC_NTF_UPDATE_EVENTS_R_POST)

<?xml version="1.0"?>
<SCC_NTF_UPDATE_EVENTS_RESP xmlns="http://xmlns.oracle.com/Enterprise/HCM/services">
   <TOTAL_EVENTS_COUNT>12</TOTAL_EVENTS_COUNT>
   <READ_EVENTS_COUNT>8</READ_EVENTS_COUNT>
   <UNREAD_EVENTS_COUNT>4</UNREAD_EVENTS_COUNT>
   <RESP_DTTM>03/25/2014 12:38:47.000000</RESP_DTTM>
</SCC_NTF_UPDATE_EVENTS_RESP>

Tag Item	Tag Item Details
TOTAL_EVENTS_COUNT	Total number of events from NUM_PAST_DAYS sent in the request.
READ_EVENTS_COUNT	Total number of read events from NUM_PAST_DAYS sent in the request.
UNREAD_EVENTS_COUNT	Total number of unread events from NUM_PAST_DAYS sent in the request.
RESP_DTTM	Timestamp of the response.