FERPA Service Messages
FERPA web services uses two types of messaging. The system generates outbound messages when a Constituent's FERPA data is changed in Campus Solutions. A change in any data element in the FERPA message definition raises this condition. The system publishes the FERPA message so that any integrated external system can be informed. When a third-party or external system needs to query the Campus Solutions database to view data, the system generates a query message. This is a synchronous inbound request/response get service, in which a third party raises a query or data request and the Campus Solutions system delivers a response that contains the requested data details.
FERPA web services deliver the following messages, which are defined using PeopleTools Integration Broker:
SCC_FERPA_REQ_MSG
SCC_FERPA_DATA_MSG
Message Property |
Value |
---|---|
Message |
SCC_FERPA_REQ_MSG |
Version |
V1 |
Message Alias |
Not Applicable (N/A) |
Description |
Ferpa Request Message |
Message Type |
Container based Message |
Part Message |
SCC _ENTITY_FERPA_REQ |
Message Property |
Value |
---|---|
Message |
SCC_FERPA_DATA_MSG |
Version |
V1 |
Message Alias |
Not Applicable (N/A) |
Description |
Ferpa Data Message |
Message Type |
Container based Message |
Part Message |
SCC_ENTITY_FERPA_DATA |
Message Property |
Value |
---|---|
Message |
SCC_ENTITY_FERPA_REQ |
Version |
V1 |
Message Alias |
Not Applicable (N/A) |
Description |
Ferpa Entity Request Part Message |
Message Type |
Non Rowset based Part Message |
Message Property |
Value |
---|---|
Message |
SCC_ENTITY_FERPA_DATA |
Version |
V1 |
Message Alias |
Not Applicable (N/A) |
Description |
Ferpa Entity Data Part Message |
Message Type |
Non Rowset based Part Message |
Sample Request Message:
<?xml version="1.0"?>
<SCC_FERPA_REQ_MSG xmlns:xs="http://www.w3.org/2001/XMLSchema">
<SCC_ENTITY_FERPA_REQ>
<EMPLID>AA0002</EMPLID>
</SCC_ENTITY_FERPA_REQ>
</SCC_FERPA_REQ_MSG>
Sample Data Message:
<?xml version="1.0"?>
<SCC_FERPA_DATA_MSG>
<SCC_ENTITY_FERPA_DATA>
<EMPLID>AA0002</EMPLID>
<FERPA>Y</FERPA>
<SCC_FERPA_OVRD_VW>
<RECNAME>Extracurricular Activities</RECNAME>
<SCC_FERPA_OVERRIDE>
<FIELDNAME>Archery</FIELDNAME>
<SCC_FERPA_PUB_CATG>
<INST_PUB_CATG>Directories</INST_PUB_CATG>
</SCC_FERPA_PUB_CATG>
</SCC_FERPA_OVERRIDE>
<SCC_FERPA_OVERRIDE>
<FIELDNAME>Basketball</FIELDNAME>
<SCC_FERPA_PUB_CATG>
<INST_PUB_CATG>Directories</INST_PUB_CATG>
</SCC_FERPA_PUB_CATG>
<SCC_FERPA_PUB_CATG>
<INST_PUB_CATG>All Community Directories</INST_PUB_CATG>
</SCC_FERPA_PUB_CATG>
</SCC_FERPA_OVERRIDE>
<SCC_FERPA_OVERRIDE>
<FIELDNAME>Football</FIELDNAME>
<SCC_FERPA_PUB_CATG>
<INST_PUB_CATG>Student Community
Directories</INST_PUB_CATG>
</SCC_FERPA_PUB_CATG>
</SCC_FERPA_OVERRIDE>
</SCC_FERPA_OVRD_VW>
</SCC_ENTITY_FERPA_DATA>
</SCC_FERPA_DATA_MSG>
The following entities are delivered:
SCC_FERPA_REQ
Entity ID: |
Not Applicable (N/A) |
Name: |
SCC_FERPA_REQ |
Status: |
Active |
Entity Type: |
Basic Entity |
Description: |
Ferpa Request Entity |
AppClass: |
Not Applicable (N/A) |
Prod Record: |
SCC_PERS_SA_VW |
Element (XML): |
SCC_ENTITY_FERPA_REQ |
Child Entities: |
Not Applicable (N/A) |
SCC_FERPA_DATA
Entity ID: |
Not Applicable (N/A) |
Name: |
SCC_FERPA_DATA |
Status: |
Active |
Entity Type: |
Basic Entity |
Description: |
Ferpa Data Entity |
AppClass: |
Not Applicable (N/A) |
Prod Record: |
SCC_PERS_SA_VW |
Element (XML): |
SCC_ENTITY_FERPA_DATA |
Child Entities: |
SCC_FERPA_OVRD_VW |
SCC_FERPA_OVRD_VW
Entity ID: |
Not Applicable (N/A) |
Name: |
SCC_FERPA_OVRD_VW |
Status: |
Active |
Entity Type: |
Basic Entity |
Description: |
Ferpa Override View Entity |
AppClass: |
Not Applicable (N/A) |
Prod Record: |
FERPA_OVRD_VW |
Element (XML): |
SCC_ FERPA_OVRD_VW |
Child Entities: |
SCC_FERPA_OVERRIDE |
SCC_FERPA_OVERRIDE
Entity ID: |
Not Applicable (N/A) |
Name: |
SCC_FERPA_OVERRIDE |
Status: |
Active |
Entity Type: |
Basic Entity |
Description: |
Ferpa Override Entity |
AppClass: |
Not Applicable (N/A) |
Prod Record: |
FERPA_OVERRIDE |
Element (XML): |
SCC_FERPA_OVERRIDE |
Child Entities: |
SCC_FERPA_PUB_CATG |
SCC_FERPA_PUB_CATG
Entity ID: |
Not Applicable (N/A) |
Name: |
SCC_FERPA_PUB_CATG |
Status: |
Active |
Entity Type: |
Basic Entity |
Description: |
Ferpa Pub Catg Entity |
AppClass: |
Not Applicable (N/A) |
Prod Record: |
FERPA_PUB_CATG |
Element (XML): |
SCC_FERPA_PUB_CATG |
Child Entities: |
Not Applicable (N/A) |