readStaffingProfileHeader

Purpose

This operation reads a staffing profile header in PPM Center.

Function

This operation enables external applications to read a staffing profile header in PPM Center identified by staffing profile ID. The operation returns the staffing profile object

To perform this operation, the user must meet the following conditions:

• Have the view staffing profile access grant

• In the Staffing profile ACL list

Related Information

The following data types:

• StaffingProfileHeaderType

• ParentEntityType

• ParentType

• ParentIdentifier

Input

The staffing profile ID

Return

A StaffingProfileHeaderType object will be returned if the staffing profile is created successfully.

Java Interface

Public com.mercury.itg.ws.rm.vo.StaffingProfileHeaderWSBean readStaffingProfileHeader(long staffingProfileId)

Parameters	Description
staffingProfileId	Staffing profile ID

Java Examples

Example: reads a staffing profile header

private StaffingProfileHeaderType
readStaffingProfileHeader(String serviceURL, Long id) throws
Exception{

      StaffingProfileHeaderType spHeaderType = null;
      StaffingProfileServiceStub stub = new
StaffingProfileServiceStub(ctx, serviceURL);
   ReadStaffingProfileHeaderDocument inDoc =
ReadStaffingProfileHeaderDocument.Factory.newInstance();
   ReadStaffingProfileHeaderDocument.ReadStaffingProfileHeader
readSPHeader = inDoc.addNewReadStaffingProfileHeader();
        readSPHeader.setStaffingProfileId(id);
      // Invoke web service
    ReadStaffingProfileHeaderResponseDocument outDoc =
stub.readStaffingProfileHeader(inDoc);
    spHeaderType =
outDoc.getReadStaffingProfileHeaderResponse().getReturn();

    return spHeaderType;
}

Errors and Exceptions

Possible root cause descriptions:

Message Code	Message	Cause(s)	Possible Corrective Action
rm.ws.exception.StaffingProfileNotExist	Staffing profile does not exist	The staffing profile cannot be found by using the staffing profile ID	Verify that the staffing profile ID exists
exception.authorization	You do not have the privilege to take this action. Please consult your PPM Administrator	You do not have the required access grants for this operation	Verify that your account has the required access grants