Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

Required?

Default

Description

Sample Data

EngagementStageId

Int32



Engagement Stage Id. For internal use only.


EngagementStageName

String



Engagement Stage Name

Open

EngagementStageShortName

String



Engagement Stage Short Name

OP

EngagementStageUid

Int64



A unique and immutable Id for an Engagement Stage.

1152921504606849675

Usage Example(s)


Example 01
                     <EngagementStageIdentity>
                        <EngagementStageId i:nil="true"/>
                        <EngagementStageName>Open</EngagementStageName>
                        <EngagementStageShortName>OP</EngagementStageShortName>
                        <EngagementStageUid>1152921504606849675</EngagementStageUid>
                     </EngagementStageIdentity>
  • No labels