Using Get Checklist Web Services

The section describes the SOAP and REST Get Checklist web services.

This is a description of the SOAP Get Checklist Web Service Operation:

Service

SCC_CONSTITUENT

Operation

SCC_GET_CHECKLIST

Summary

The inbound Get Checklist service retrieves Self-service Checklist items for a person

Description

This Service Operation retrieves personal checklist details of the constituent.

Request Parameters (not mandatory):
- SEQ_3C
- LanguageCd
- SCC_PROFILE_ID
Validation performed for SCC_GET_CHECKLIST:

Self-service – Get Checklist 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 checklist information.
Responds with the chec list information/error messages.

Output

Response message contains checklist 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:

Image: SCC_GET_CHKLST_REQ Message Structure

This example illustrates the fields and controls on the SCC_GET_CHKLST_REQ Message Structure. You can find definitions for the fields and controls later on this page.

The following is an example of the SCC_GETCHKLST_REQ message that the SCC_GET_CHECKLIST service operation receives from an SCE request:

<?xml version="1.0"?>
<SCC_GET_CHKLST_REQ xmlns="http://xmlns.oracle.com/Enterprise/HCM/services" xmlns:wsu=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"/>

When the Integration Broker receives the SCC_GET_CHKLST_REQ message, it responds with the SCC_GET_CHKLST_RESP message the structure of which is shown below:

Image: SCC_GET_CHKLST_RESP Message Structure (1 of 3)

This example illustrates the fields and controls on the SCC_GET_CHKLST_RESP Message Structure (1 of 3). You can find definitions for the fields and controls later on this page.

Image: SCC_GET_CHKLST_RESP Message Structure (2 of 3)

This example illustrates the fields and controls on the SCC_GET_CHKLST_RESP Message Structure (2 of 3). You can find definitions for the fields and controls later on this page.

Image: SCC_GET_CHKLST_RESP Message Structure (3 of 3)

This example illustrates the fields and controls on the SCC_GET_CHKLST_RESP Message Structure (3 of 3). You can find definitions for the fields and controls later on this page.

The following is an example of the SCC_GET_CHKLST_RESP message that the SCC_GETCHECKLIST service operation transmits to the UI:

<?xml version="1.0"?>
<SCC_GET_CHKLST_RESP xmlns="http://xmlns.oracle.com/Enterprise/HCM/services">
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>3</SEQ_3C>
    <CHECKLIST_SEQ>200</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>ENRL5</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Complete Enrollment</CHECKLIST_CD_DESCR>
    <INFORMATION>Confirm you study choices in the system by:
     1. Logging onto the Self Service portal of the University system and enrolling 
     (if you are unable to do this, contact Student Administration for assistance
     2. Complete the government funding form and submit it on line
     3. Complete the student survey form and submit it
   You are now ready to study!</INFORMATION>
    <DUE_DT>2013-09-15</DUE_DT>
    <ADMIN_FUNCTION>STRM</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Student Term</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>3</SEQ_3C>
    <CHECKLIST_SEQ>300</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>ENRL2</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Determine Enrollment Deadlines</CHECKLIST_CD_DESCR>
    <INFORMATION>Ensure you understand the dates by which you must complete 
     enrollment-related activities.  You can find this information at 
     http://www.psunv.edu/handbook/2013_dates.html.  Ensure that you can meet 
     these deadlines or contact your academic adviser immediately 
     if you might be unable to.</INFORMATION>
    <DUE_DT>2013-09-10</DUE_DT>
    <ADMIN_FUNCTION>STRM</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Student Term</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>3</SEQ_3C>
    <CHECKLIST_SEQ>400</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>ENRL3</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Identify Academic Adviser</CHECKLIST_CD_DESCR>
    <INFORMATION>Identify the person who will be your academic adviser and find 
     their contact details as soon as possible as you will need to discuss your 
     academic plans with them and obtain their approval for your program.  You can 
     determine who your adviser is by consulting the entry for your program in 
     the Handbook at http://www.psunv.edu/handbook/2013_programs.html.  If you 
     have any trouble, contact Student Administration for assistance.</INFORMATION>
    <DUE_DT>2013-09-05</DUE_DT>
    <ADMIN_FUNCTION>STRM</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Student Term</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>3</SEQ_3C>
    <CHECKLIST_SEQ>500</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>ENRL4</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Work out your timetable</CHECKLIST_CD_DESCR>
    <INFORMATION>Now that you have your academic program resolved, you need 
     to work out you weekly lecture and tutorial timetable.  This is entirely 
     your responsibility but your academic adviser had probably provided you 
     with some tips already.  Be sure to avoid clashes between commitments 
     and to understand where lectures and tutorials will be located so that 
     you can allow adequate traveling time to reach them.</INFORMATION>
    <DUE_DT>2013-09-07</DUE_DT>
    <ADMIN_FUNCTION>STRM</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Student Term</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>2</SEQ_3C>
    <CHECKLIST_SEQ>100</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>PARK01</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Parking Application Form</CHECKLIST_CD_DESCR>
    <INFORMATION>Complete a form and the declaration to be able 
     to use on-campus parking.</INFORMATION>
    <DUE_DT>2013-09-02</DUE_DT>
    <ADMIN_FUNCTION>GEN</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>General</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>0</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>2</SEQ_3C>
    <CHECKLIST_SEQ>200</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>PARK02</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Parking Token Fee</CHECKLIST_CD_DESCR>
    <INFORMATION>Fee and deposit for a secure parking token.</INFORMATION>
    <DUE_DT>2013-09-02</DUE_DT>
    <ADMIN_FUNCTION>GEN</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>General</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>0</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>1</SEQ_3C>
    <CHECKLIST_SEQ>100</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>TOEFL</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Test of Engl as a Foreign Lang</CHECKLIST_CD_DESCR>
    <INFORMATION>All international applicants for whom English is not 
     a native language must have their results from the Test of English 
     as a Foreign Language (TOEFL) submitted directly to us 
     from the testing agency.</INFORMATION>
    <DUE_DT>2013-09-25</DUE_DT>
    <ADMIN_FUNCTION>ADMA</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Admissions Application</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>1</SEQ_3C>
    <CHECKLIST_SEQ>200</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>DEAN</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Dean's Report</CHECKLIST_CD_DESCR>
    <INFORMATION>All applicants are required to submit a dean's report 
     from their previous school.</INFORMATION>
    <DUE_DT>2013-09-25</DUE_DT>
    <ADMIN_FUNCTION>ADMA</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Admissions Application</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>1</SEQ_3C>
    <CHECKLIST_SEQ>300</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>MEDIC</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Medical Approval</CHECKLIST_CD_DESCR>
    <INFORMATION/>
    <DUE_DT>2013-09-25</DUE_DT>
    <ADMIN_FUNCTION>ADMA</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Admissions Application</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
  <PERSON_CHKLST_ITEM>
    <EMPLID>SCE0001</EMPLID>
    <SEQ_3C>1</SEQ_3C>
    <CHECKLIST_SEQ>400</CHECKLIST_SEQ>
    <CHKLST_ITEM_CD>TRANS</CHKLST_ITEM_CD>
    <ITEM_STATUS>I</ITEM_STATUS>
    <ITEM_STATUS_LOVDescr>Initiated</ITEM_STATUS_LOVDescr>
    <CHECKLIST_CD_DESCR>Academic Transcripts</CHECKLIST_CD_DESCR>
    <INFORMATION/>
    <DUE_DT>2013-09-25</DUE_DT>
    <ADMIN_FUNCTION>ADMA</ADMIN_FUNCTION>
    <ADMIN_FUNCTION_DESCR>Admissions Application</ADMIN_FUNCTION_DESCR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <RESPONSIBLE_ID>KU0007</RESPONSIBLE_ID>
    <EMAIL_ADDR>HCMGENUser1@ap6023fems.us.oracle.com</EMAIL_ADDR>
    <VAR_DATA_SEQ>1</VAR_DATA_SEQ>
    <ASSOC_ID/>
    <NAME/>
    <RESPONSIBLE_NAME>Locherty,Betty</RESPONSIBLE_NAME>
  </PERSON_CHKLST_ITEM>
</SCC_GET_CHKLST_RESP>

When the Integration Broker receives the SCC_GET_CHKLST_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 Get Checklist Web Service Operation:

Service

SCC_CONSTITUENT_R

Operation

SCC_GET_CHECKLIST_R_GET

EndPoint

http://<hostname>:<port>//PSIGW/RESTListeningConnector/SCC_GET_CHECKLIST_R.v1/ checklist/get?SCC_PROFILE_ID={SCC_PROFILE_ID}&languageCd={languageCd}