Inbound Services
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. 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.