Outbound and Inbound Services
The PeopleSoft system delivers three outbound and two inbound web service operations. For information about web services as well as samples of the XML messages that the services generate, see PeopleSoft Campus Solutions Constituent Web Services Developer's Guide posted on My Oracle Support.
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
Workforce Administration – Add a Person (if the institution is using a combined instance of HCM/CS)
In general an outbound message is published from any place within Campus Community where a person or his attributes 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.
The PeopleSoft system delivers two inbound service operations to manage changes to constituent data. In order to respond to constituent data updates generated in external systems, the constituent web service must listen to and process the inbound response.
Read ("Get") Constituent
Use this operation to request the details of a single constituent in the Campus Solutions system.
Supported Interaction Patterns
|
Request/Response |
Service |
Operation |
|---|---|---|
|
Asynchronous Request |
N/A |
N/A |
|
Synchronous Request/Response |
SCC_CONSTITUENT |
SCC_GET_CONSTITUENT |
Request Message
The request message is the EmplID, the unique identifier for a constituent.
Response Message
If a constituent is found with the supplied EmplID then the service returns the populated constituent object. Otherwise, it returns a null constituent object.
Behavior
The constituent service validates the EmplID, if present, and populates the response message with all details of the constituent accessible to the caller.
Update Constituent
Use this operation to update the information of a single constituent in the Campus Solutions system.
Supported Interaction Patterns
|
Request/Response |
Service |
Operation |
|---|---|---|
|
Asynchronous Request |
SCC_CONSTITUENT_IN_SYNC |
SCC_CONSTITUENT_IN_SYNC |
|
Synchronous Request/Response |
N/A |
N/A |
Request Message
The request message contains the EmplID to uniquely identify the constituent to be updated, along with any attributes of the constituent that need to be updated.
Response Message (synchronous only)
The response indicates whether the constituent was updated successfully. If not, the system returns a constituent fault message that includes the detailed error messages and explanations.
Behavior
The constituent service validates the data passed in the request message. If the request is valid and the constituent can be found then the constituent is updated. All CS and HCM validation is performed. If any aspect of the data is invalid then the entire request is rejected. If an attempt is made to update non-updatable constituent attributes then the caller may be warned of this in the response.
Query Constituent
Use this operation to query against the constituents contained within the Campus Solutions system.
Supported Interaction Patterns
|
Request/Response |
Service |
Operation |
|---|---|---|
|
Asynchronous Request |
N/A |
N/A |
|
Synchronous Request/Response |
SCC_CONSTITUENT |
SCC_GET_CONSTITUENT |
Request Message
The request message is the Campus Solutions Search/Match request object. This message contains a list of fields that can be partially populated in order to perform a search against the database for potential constituents that match the criteria. The request also includes the Search/Match setup ID.
Response Message
The response includes a collection of zero to many Search/Match results objects. The Search/Match result object contains partial constituent details along with weighting information that can be used to determine which returned constituent best matches the criteria.
Behavior
The operation validates the Search/Match request. If the request is valid, the system performs a Search/Match against the database and returns the results.