Using Get Service Indicators Web Services

The section describes the SOAP and REST Get Service Indicators web services.

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

Service

SCC_CONSTITUENT

Operation

SCC_GET_SERVICE_INDICATORS

Summary

The inbound Get Service Indicators service retrieves Self-service Service Indicators items for a person

Description

This Service Operation retrieves Self-service Service Indicators for a person

  • Request Parameters (not mandatory):

    • LanguageCd

    • SCC_PROFILE_ID

  • Validation performed for SCC_GET_CHECKLIST:

    Self-service – Get Service Indicator 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 Service Indicators information.

  • Responds with the personal service indicator information/error messages.

Output

Response message contains Service Indicators 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_GET_SERVICE_IND_REQ Message Structure. You can find definitions for the fields and controls later on this page.

SCC_GET_SERVICE_IND_REQ Message Structure

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

<?xml version="1.0"?>
<SCC_GET_SERVICE_IND_REQ xmlns="http://xmlns.oracle.com/Enterprise/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_SERVICE_IND_REQ message, it responds with the SCC_GET_SERVICE_IND_RESP message the structure of which is shown below.

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

SCC_GET_SERVICE_IND_RESP Message Structure (1 of 5)

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

SCC_GET_SERVICE_IND_RESP Message Structure (2 of 5)

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

SCC_GET_SERVICE_IND_RESP Message Structure (3 of 5)

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

SCC_GET_SERVICE_IND_RESP Message Structure (4 of 5)

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

SCC_GET_SERVICE_IND_RESP Message Structure (5 of 5)

The following is an example of the SCC_GET_SERVICE_IND_RESP message that the SCC_GET_SERVICE_INDICATORS service operation transmits to the UI:

<?xml version="1.0"?>
<SCC_GET_SERVICE_IND_RESP xmlns="http://xmlns.oracle.com/Enterprise/services">
  <SERVICE_INDICATOR>
    <EMPLID>SCE0001</EMPLID>
    <SRVC_IND_DTTM>08/26/2013 10:36:44.000000</SRVC_IND_DTTM>
    <SRVC_IND_ACTIVE_DT>2013-03-01</SRVC_IND_ACTIVE_DT>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <SRVC_IND_CD>RG2</SRVC_IND_CD>
    <SRVC_IND_CD_DESCR>No Enroll - Add/Drop OK</SRVC_IND_CD_DESCR>
    <SRVC_IND_REASON>REG2</SRVC_IND_REASON>
    <SRVC_IND_ACT_TERM>0700</SRVC_IND_ACT_TERM>
    <SRVC_IND_ACT_TERM_DESCR>2013 Spring</SRVC_IND_ACT_TERM_DESCR>
    <DEPTID>10000</DEPTID>
    <DEPTID_DESCR>Human Resources</DEPTID_DESCR>
    <CONTACT_ID>SCE0005</CONTACT_ID>
    <CONTACT>Davis,Paul</CONTACT>
    <EMAIL_ADDR/>
    <AMOUNT>1000</AMOUNT>
    <CURRENCY_CD>USD</CURRENCY_CD>
    <CURRENCY_CD_LOVDescr>US Dollar</CURRENCY_CD_LOVDescr>
    <INSTRUCTIONS/>
    <SCC_SI_END_DT/>
    <SCC_SI_END_TERM/>
    <SRVC_IND_END_TERM_DESCR/>
    <SRVC_IND_REASON_DESCR>Registrar Hold</SRVC_IND_REASON_DESCR>
    <POS_SRVC_INDICATOR>N</POS_SRVC_INDICATOR>
  </SERVICE_INDICATOR>
  <SERVICE_INDICATOR>
    <EMPLID>SCE0001</EMPLID>
    <SRVC_IND_DTTM>08/26/2013 10:35:27.000000</SRVC_IND_DTTM>
    <SRVC_IND_ACTIVE_DT>2013-08-01</SRVC_IND_ACTIVE_DT>
    <INSTITUTION>PSUNV</INSTITUTION>
    <INSTITUTION_DESCR>PeopleSoft University</INSTITUTION_DESCR>
    <SRVC_IND_CD>REF</SRVC_IND_CD>
    <SRVC_IND_CD_DESCR>No Refunds</SRVC_IND_CD_DESCR>
    <SRVC_IND_REASON>NOPAY</SRVC_IND_REASON>
    <SRVC_IND_ACT_TERM/>
    <SRVC_IND_ACT_TERM_DESCR/>
    <DEPTID>10000</DEPTID>
    <DEPTID_DESCR>Human Resources</DEPTID_DESCR>
    <CONTACT_ID>0002</CONTACT_ID>
    <CONTACT>Jones,Susan</CONTACT>
    <EMAIL_ADDR>nigel.woods@oracle.com</EMAIL_ADDR>
    <AMOUNT>2500</AMOUNT>
    <CURRENCY_CD>USD</CURRENCY_CD>
    <CURRENCY_CD_LOVDescr>US Dollar</CURRENCY_CD_LOVDescr>
    <INSTRUCTIONS/>
    <SCC_SI_END_DT/>
    <SCC_SI_END_TERM/>
    <SRVC_IND_END_TERM_DESCR/>
    <SRVC_IND_REASON_DESCR>Non Payment of Fees</SRVC_IND_REASON_DESCR>
    <POS_SRVC_INDICATOR>N</POS_SRVC_INDICATOR>
  </SERVICE_INDICATOR>
</SCC_GET_SERVICE_IND_RESP>

When the Integration Broker receives the SCC_GET_SERVICE_IND_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 Service Indicators Web Service Operation:

Service

SCC_CONSTITUENT_R

Operation

SCC_GET_SERVICE_INDICATORS_R_G

EndPoint

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

Summary

Refer to the Get Service Indicators SOAP Service Operation.

Description

Refer to the Get Service Indicators SOAP Service Operation.

Users

Refer to the Get Service Indicators SOAP Service Operation.

Processing

Refer to the Get Service Indicators SOAP Service Operation.

Output

Refer to the Get Service Indicators SOAP Service Operation.

Error Conditions

Refer to the Get Service Indicators SOAP Service Operation.

Refer to the Get Service Indicators SOAP Service Operation.

Refer to the Get Service Indicators SOAP Service Operation.

Refer to the Get Service Indicators SOAP Service Operation.