Using Submit User Preferences Web Services
The section describes the SOAP and REST Submit User Preferences web services.
This is a description of the SOAP Submit User Preferences Web Service Operation:
Service
SCC_CONSTITUENT
Operation
SCC_SUBMIT_USERPREF
Summary
The inbound Submit User Preferences service submits user preferences for a person.
Description
This Service Operation submits user preference details for the constituent.
Validation performed for SCC_SUBMIT_USERPREF:
Self-service – Submit User Preferences requests are always built with EMPLID = UserId’s EMPLID.
Users
Student
Processing
This service operation performs the following steps:
Verify required input parameters exist.
Performs the above mentioned validations on the input parameters.
Retrieves the available personal information.
Responds with the personal information/error messages.
Output
Response message contains user preferences information/error messages for constituent.
Error Conditions
The service operation results in error in the following conditions:
Invalid input parameters.
Any of the validations mentioned above fail.
The following diagram shows the input message structure:
This example illustrates the fields and controls on the SCC_SUBMIT_USERPREF_REQ Message Structure. You can find definitions for the fields and controls later on this page.
<?xml version="1.0"?>
<SCC_SUBMIT_USERPREF_REQ xmlns="http://xmlns.oracle.com/Enterprise/services">
<USER_PREFERENCE>
<EMPLID/>
<NAME_DISPLAY/>
<OPERATOR_DEFAULT>
<OPRID>PS</OPRID>
<INSTITUTION>PSUNV</INSTITUTION>
<INSTITUTION_LOVDescr>PeopleSoft University</INSTITUTION_LOVDescr>
<STRM>0505</STRM>
<STRM_LOVDescr>2003 Fall</STRM_LOVDescr>
<AID_YEAR>2004</AID_YEAR>
<AID_YEAR_LOVDescr>Financial Aid Year 2003-2004</AID_YEAR_LOVDescr>
<ACAD_CAREER>UGRD</ACAD_CAREER>
<ACAD_CAREER_LOVDescr>Undergraduate</ACAD_CAREER_LOVDescr>
</OPERATOR_DEFAULT>
<COMM_PREFERENCE>
<EMPLID>KU0007</EMPLID>
<LANG_CD>ENG</LANG_CD>
<LANG_CD_LOVDescr>English</LANG_CD_LOVDescr>
<COMM_METHOD>E</COMM_METHOD>
<COMM_METHOD_LOVDescr>E-Mail</COMM_METHOD_LOVDescr>
</COMM_PREFERENCE>
<NOTIFICATION_PREFERENCE>
<EMPLID>KU0007</EMPLID>
<SCC_EMAIL_NTF_IND>Y</SCC_EMAIL_NTF_IND>
<SCC_SMS_NTF_IND>Y</SCC_SMS_NTF_IND>
<E_ADDR_TYPE>HOME</E_ADDR_TYPE>
<PHONE_TYPE>HOME</PHONE_TYPE>
<SCC_NTF_LANG/>
<PHONE>555/123-4567</PHONE>
<EMAIL_ADDR>GENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
</NOTIFICATION_PREFERENCE>
<USER_PERSONALIZATIONS>
<USER_PERSONALIZATION>
<OPRID>PS</OPRID>
<OPTN_CATEGORY>GENERAL</OPTN_CATEGORY>
<DESCR>General Options</DESCR>
<DESCR254>Personalize General Options</DESCR254>
<USER_PERS_CATEGORIES>
<USER_PERSONALIZATION_CATEGORY>
<OPTN_CATEGORY_LVL>PPTL</OPTN_CATEGORY_LVL>
<OPTN_CATEGORY_LVL_LOVDescr>PeopleTools</OPTN_CATEGORY_LVL_LOVDescr>
<USEROPTN>ACCESS</USEROPTN>
<USEROPTN_LOVDescr>Accessibility Features</USEROPTN_LOVDescr>
<OPTN_CATEGORY>GENERAL</OPTN_CATEGORY>
<OPTN_CATEGORY_GRP>PIA</OPTN_CATEGORY_GRP>
<DEFAULT_VALUE>N</DEFAULT_VALUE>
<DEFAULT_VALUE_DESCR>Accessibility features off</DEFAULT_VALUE_DESCR>
<OVERRIDE_VALUE>N</OVERRIDE_VALUE>
<OVERRIDE_VALUE_DESCR>Accessibility features off</OVERRIDE_VALUE_DESCR>
<EXPLANATION>Provides better support for assistive technologies.
Use accessible mode layout - This option is for use with screen readers.
Page elements (fields, links, buttons, etc.) are presented linearly to
assistive software.
Use standard mode layout - This option supports assistive technologies
without altering the page design.
Accessibility Features disabled - This option is the default.</EXPLANATION>
<OVERRIDE__VALUES>
<OVERRIDE__VALUE>
<FIELDVALUE>A</FIELDVALUE>
<DESCR>Use accessible layout mode</DESCR>
</OVERRIDE__VALUE>
<OVERRIDE__VALUE>
<FIELDVALUE>N</FIELDVALUE>
<DESCR>Accessibility features off</DESCR>
</OVERRIDE__VALUE>
<OVERRIDE__VALUE>
<FIELDVALUE>S</FIELDVALUE>
<DESCR>Use standard layout mode</DESCR>
</OVERRIDE__VALUE>
</OVERRIDE__VALUES>
</USER_PERSONALIZATION_CATEGORY>
</USER_PERS_CATEGORIES>
</USER_PERSONALIZATION>
<USER_PERSONALIZATION>
<OPRID>PS</OPRID>
<OPTN_CATEGORY>LOCALE</OPTN_CATEGORY>
<DESCR>Regional Settings</DESCR>
<DESCR254>Personalize Regional Settings</DESCR254>
<USER_PERS_CATEGORIES>
<USER_PERSONALIZATION_CATEGORY>
<OPTN_CATEGORY_LVL>PPTL</OPTN_CATEGORY_LVL>
<OPTN_CATEGORY_LVL_LOVDescr>PeopleTools</OPTN_CATEGORY_LVL_LOVDescr>
<USEROPTN>DCSP</USEROPTN>
<USEROPTN_LOVDescr>Decimal Separator</USEROPTN_LOVDescr>
<OPTN_CATEGORY>LOCALE</OPTN_CATEGORY>
<OPTN_CATEGORY_GRP>PIA</OPTN_CATEGORY_GRP>
<DEFAULT_VALUE>.</DEFAULT_VALUE>
<DEFAULT_VALUE_DESCR>.</DEFAULT_VALUE_DESCR>
<OVERRIDE_VALUE/>
<OVERRIDE_VALUE_DESCR/>
<EXPLANATION>Any single character, commonly either '.' or ','.
Determines if 1.00 is displayed as 1.00 or 1,00.</EXPLANATION>
<OVERRIDE__VALUES>
<OVERRIDE__VALUE>
<FIELDVALUE/>
<DESCR/>
</OVERRIDE__VALUE>
</OVERRIDE__VALUES>
</USER_PERSONALIZATION_CATEGORY>
<USER_PERSONALIZATION_CATEGORY>
<OPTN_CATEGORY_LVL>PPTL</OPTN_CATEGORY_LVL>
<OPTN_CATEGORY_LVL_LOVDescr>PeopleTools</OPTN_CATEGORY_LVL_LOVDescr>
<USEROPTN>DFRMT</USEROPTN>
<USEROPTN_LOVDescr>Date Format</USEROPTN_LOVDescr>
<OPTN_CATEGORY>LOCALE</OPTN_CATEGORY>
<OPTN_CATEGORY_GRP>PIA</OPTN_CATEGORY_GRP>
<DEFAULT_VALUE>M</DEFAULT_VALUE>
<DEFAULT_VALUE_DESCR>MMDDYY</DEFAULT_VALUE_DESCR>
<OVERRIDE_VALUE>M</OVERRIDE_VALUE>
<OVERRIDE_VALUE_DESCR>MMDDYY</OVERRIDE_VALUE_DESCR>
<EXPLANATION>Determines whether date will be displayed with the day first,
month first, or year first. The century (YYYY or YY) is controlled as a
page field property, not a personalization.</EXPLANATION>
<OVERRIDE__VALUES>
<OVERRIDE__VALUE>
<FIELDVALUE>D</FIELDVALUE>
<DESCR>DDMMYY</DESCR>
</OVERRIDE__VALUE>
<OVERRIDE__VALUE>
<FIELDVALUE>M</FIELDVALUE>
<DESCR>MMDDYY</DESCR>
</OVERRIDE__VALUE>
<OVERRIDE__VALUE>
<FIELDVALUE>Y</FIELDVALUE>
<DESCR>YYMMDD</DESCR>
</OVERRIDE__VALUE>
</OVERRIDE__VALUES>
</USER_PERSONALIZATION_CATEGORY>
<USER_PERSONALIZATION_CATEGORY>
<OPTN_CATEGORY_LVL>PPTL</OPTN_CATEGORY_LVL>
<OPTN_CATEGORY_LVL_LOVDescr>PeopleTools</OPTN_CATEGORY_LVL_LOVDescr>
<USEROPTN>DTSP</USEROPTN>
<USEROPTN_LOVDescr>Date Separator</USEROPTN_LOVDescr>
<OPTN_CATEGORY>LOCALE</OPTN_CATEGORY>
<OPTN_CATEGORY_GRP>PIA</OPTN_CATEGORY_GRP>
<DEFAULT_VALUE>/</DEFAULT_VALUE>
<DEFAULT_VALUE_DESCR>/</DEFAULT_VALUE_DESCR>
<OVERRIDE_VALUE/>
<OVERRIDE_VALUE_DESCR/>
<EXPLANATION>Any single character, common values are ' /', '-' or '.'.
This determines whether the date will be shown as DD/MM/YY or DD-MM-YY
for example.</EXPLANATION>
<OVERRIDE__VALUES>
<OVERRIDE__VALUE>
<FIELDVALUE/>
<DESCR/>
</OVERRIDE__VALUE>
</OVERRIDE__VALUES>
</USER_PERSONALIZATION_CATEGORY>
<USER_PERSONALIZATION_CATEGORY>
<OPTN_CATEGORY_LVL>PPTL</OPTN_CATEGORY_LVL>
<OPTN_CATEGORY_LVL_LOVDescr>PeopleTools</OPTN_CATEGORY_LVL_LOVDescr>
<USEROPTN>TFRMT</USEROPTN>
<USEROPTN_LOVDescr>Time Format</USEROPTN_LOVDescr>
<OPTN_CATEGORY>LOCALE</OPTN_CATEGORY>
<OPTN_CATEGORY_GRP>PIA</OPTN_CATEGORY_GRP>
<DEFAULT_VALUE>C</DEFAULT_VALUE>
<DEFAULT_VALUE_DESCR>12 hour clock</DEFAULT_VALUE_DESCR>
<OVERRIDE_VALUE/>
<OVERRIDE_VALUE_DESCR/>
<EXPLANATION>Determines whether time will be displayed in civilian (8:05:00 PM)
or military (20:05:00) time format. The determination of whether seconds and
microseconds are displayed is made at the field level, and is not a
personalization.</EXPLANATION>
<OVERRIDE__VALUES>
<OVERRIDE__VALUE>
<FIELDVALUE>C</FIELDVALUE>
<DESCR>12 hour clock</DESCR>
</OVERRIDE__VALUE>
<OVERRIDE__VALUE>
<FIELDVALUE>M</FIELDVALUE>
<DESCR>24 hour clock</DESCR>
</OVERRIDE__VALUE>
</OVERRIDE__VALUES>
</USER_PERSONALIZATION_CATEGORY>
<USER_PERSONALIZATION_CATEGORY>
<OPTN_CATEGORY_LVL>PPTL</OPTN_CATEGORY_LVL>
<OPTN_CATEGORY_LVL_LOVDescr>PeopleTools</OPTN_CATEGORY_LVL_LOVDescr>
<USEROPTN>TSEP</USEROPTN>
<USEROPTN_LOVDescr>Digit Group Separator</USEROPTN_LOVDescr>
<OPTN_CATEGORY>LOCALE</OPTN_CATEGORY>
<OPTN_CATEGORY_GRP>PIA</OPTN_CATEGORY_GRP>
<DEFAULT_VALUE>,</DEFAULT_VALUE>
<DEFAULT_VALUE_DESCR>,</DEFAULT_VALUE_DESCR>
<OVERRIDE_VALUE/>
<OVERRIDE_VALUE_DESCR/>
<EXPLANATION>Any single character, commonly either ',' or '.'.
Determines whether 1000 shows as 1,000 or 1.000.</EXPLANATION>
<OVERRIDE__VALUES>
<OVERRIDE__VALUE>
<FIELDVALUE/>
<DESCR/>
</OVERRIDE__VALUE>
</OVERRIDE__VALUES>
</USER_PERSONALIZATION_CATEGORY>
</USER_PERS_CATEGORIES>
</USER_PERSONALIZATION>
</USER_PERSONALIZATIONS>
</USER_PREFERENCE>
</SCC_SUBMIT_USERPREF_REQ>
When the Integration Broker receives the SCC_SUBMIT_USERPREF_REQ message, it responds with the SCC_SUBMIT_USERPREF_RESP message the structure of which is shown below.
This example illustrates the fields and controls on the SCC_SUBMIT_USERPREF_RESP Message Parameters. You can find definitions for the fields and controls later on this page.
The following is an example of the SCC_SUBMIT_USERPREF_RESP message that the SCC_SUBMIT_USERPREF service operation transmits to the UI:
<?xml version="1.0"?>
<SCC_SUBMIT_USERPREF_RESP xmlns="http://xmlns.oracle.com/Enterprise/services"/>
When the Integration Broker receives the SCC_SUBMIT_USERPREF_REQ message and a validation fault is detected,it responds with the output fault message SCC_FAULT_RESP that consists of error message number, set number and the error message text.
This is a description of the SOAP Submit User Preferences Web Service Operation:
Service
SCC_CONSTITUENT_R
Operation
SCC_SUBMIT_USERPREF_R_POST
EndPoint
http://<hostname>:<port>//PSIGW/RESTListeningConnector/SCC_SUBMIT_USERPREF_R.v1/ userpref/submit
Summary
Refer to the Submit User Preferences SOAP Service Operation.
Description
Refer to the Submit User Preferences SOAP Service Operation.
Users
Refer to the Submit User Preferences SOAP Service Operation.
Processing
Refer to the Submit User Preferences SOAP Service Operation.
Output
Refer to the Submit User Preferences SOAP Service Operation.
Error Conditions
Refer to the Submit User Preferences SOAP Service Operation.
Refer to the Submit User Preferences SOAP Service Operation.
Refer to the Submit User Preferences SOAP Service Operation.
Refer to the Submit User Preferences SOAP Service Operation.