Outbound Services
Note:
The PeopleSoft system delivers three outbound service operations to notify external systems of changes to Campus Solutions constituent data, search/match for constituents in external repositories, and read ("get") constituent details for a single constituent in an external source.
Constituent Message
Use this operation to notify third parties of the creation, update, or deletion of one or more constituents in the Campus Solutions system. An outbound constituent request is sent whenever a constituent's data is updated. This includes information change by self-service users, administrators, and batch programs (for example, ISIR load).
The notification is sent whenever an administrator accesses any of these person create/update entry points:
-
Campus Community – Personal Information
-
Campus Community – Personal Information (Student)
-
Contributor Relations – Add/Update a Person
-
Student Recruiting – Add a Prospect
-
Records and Enrollment – Quick Admit
-
Student Admission – Application Entry
In general an outbound message is published from any place within Campus Community where a person or the attributes of the person can be created or updated: everywhere that PERSON_BASIC_SYNC and PERSON_SA data is used, as well as the Affiliations components and wherever the FERPA flag appears.
Supported Interaction Patterns
| Request/Response | Service | Operation |
|---|---|---|
|
Asynchronous Request |
N/A |
SCC_CONSTITUENT_SYNC |
|
Synchronous Request/Response |
Not supported |
Not supported |
Request Message
The request message contains the entire constituent object, including affiliations and the FERPA flag contained in the PERSON_SA record.
Behavior
Whenever constituent information is created or changed an XML message is published.
External Search/Match
The Campus Solutions system uses this operation to search/match (query) against constituents stored within an external system.
Supported Interaction Patterns
| Request/Response | Service | Operation |
|---|---|---|
|
Asynchronous Request |
Not supported |
Not supported |
|
Synchronous Request/Response |
SCC_SM_SERVICE |
SCC_SM_SERVICE_SYNC |
|
Synchronous Request/Response |
SCC_SM_FETCH |
SCC_SM_FETCH_SYNC |
Request Message
The request message is the external system Search/Match request object. This is a list of fields that may be partially populated to perform a search against the external system for potential constituents that match the criteria.
Behavior
The response includes all constituents matching the criteria according to the configured matching rules. Alternatively, the system returns a constituent fault message that includes detailed error messages and explanations.
External Read ("Get") Constituent
The Campus Solutions system uses this operation to read a constituent record stored within an external source.
Supported Interaction Patterns
| Request/Response | Service | Operation |
|---|---|---|
|
Asynchronous Request |
Not supported |
Not supported |
|
Synchronous Request/Response |
SCC_CONSTITUENT |
SCC_GET_CONSTITUENT |
Request Message
The request message contains the EmplID of the constituent stored in the external system.
Response Message
The response includes all constituent details stored in the external system for the given EmplID. If there is no valid response, the system returns a constituent fault message that includes the detailed error messages and explanations.
Behavior
The external system validates the EmplID transmitted in the request message and if the ID is present, the system looks up the given constituent and returns all attributes for the constituent.