Using Get Photo Web Services

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

Service

SCC_CONSTITUENT

Operation

SCC_GETPHOTO

Summary

The inbound Get Photo service retrieves and encodes the constituent’s photo image into a base64data string and populates the response message directly with the HTML image.

Description

This Service Operation retrieves the constituent photo image that is saved within the Employee Photo record.

Request Parameters:
- EMPLID
- LanguageCd
- SCC_PROFILE_ID
Validation performed for Get Photo:

Self-service – Photo 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.
Responds with information/error messages.

Output

Response message contains photo information/error messages for specified 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_GETPHOTO_REQ Message Structure

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

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

<?xml version="1.0"?>
<SCC_GETPHOTO_REQ xmlns="http://xmlns.oracle.com/Enterprise/HCM/services"/>

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

Image: SCC_GETPHOTO_RESP Message Structure

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

The following is an example of the SCC_GETPHOTO_RESP message that the SCC_GETPHOTO service operation transmits to the UI:

<?xml version="1.0"?>
<SCC_GETPHOTO_RESP xmlns="http://xmlns.oracle.com/Enterprise/HCM/services">
<EMPLOYEE_PHOTO>
<EMPLID>CCSCE0001</EMPLID>
<Base64Data>/9j/4AAQSkZJRgABAQEASABIAAD//gAgR2VuZXJhdGVkIGJ5ICBJSkcgSlBFRyBMaWJyYXJ5/
+EbVkV4aWYAAElJKgAIAAAADgAOAQIAeAAAALYAAAAPAQIABgAAAC4BAAAQAQIAFgAAADQBAAASAQMAAQAAAAEAAAAa
AQUAAQAAAEoBAAAbAQUAAQAAAFIBAAAoAQMAAQAAAAIAAAAxAQIAHAAAAFoBAAAyAQIA…………………..==</Base64Data>
</EMPLOYEE_PHOTO>
</SCC_GETPHOTO_RESP>

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

Service

SCC_CONSTITUENT_R

Operation

SCC_GETPHOTO_R_GET

EndPoint

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