Overview

This structure represents the unique key fields associated with identifying an Engagement Stage. Engagement Stages can be identified by EngagementStageName, EngagementStageShortName or EngagementStageUid. When specifying a PwsEngagementStageRef as an input to a web service, you may specify one or all three fields the EngagementStageName, EngagementStageShortName and/or EngagementStageUid. However, if you do specify all three, they must refer to the same Engagement Stage or the Engagement Stage reference will not be considered valid. When a PwsEngagementStageRef is returned in the response to a web service, the EngagementStageName, EngagementStageShortName and/or EngagementStageUid will be populated, and guaranteed to refer to a single Engagement Stage.

Format

PwsEngagementStageRef

PwsEngagementStageRef
- EngagementStageId: Int32
- EngagementStageName: String
- EngagementStageShortName: String
- EngagementStageUid: Int64

Element

Element	Data Type	Description	Sample Data
EngagementStageId	Int32	The Engagement Stage Id is a unique identifier for an Engagement Stage. For internal use only.
EngagementStageName	String	The Engagement Stage Name is a unique identifier for an Engagement.	Open
EngagementStageShortName	String	The Engagement Stage Short Name is a unique identifier for an Engagement.	OP
EngagementStageUid	Int64	The Engagement Stage Uid is a unique and immutable identifier for an Engagement.	1152921504606849675

Usage Example(s)

Example 01

                     <EngagementStageIdentity>
                        <EngagementStageId i:nil="true"/>
                        <EngagementStageName>Open</EngagementStageName>
                        <EngagementStageShortName>OP</EngagementStageShortName>
                        <EngagementStageUid>1152921504606849675</EngagementStageUid>
                     </EngagementStageIdentity>