PwsEngagementStageRef

Owned by Bettina Borces
Last updated: Apr 30, 2018 by Luke Wright
2 min read

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 any combination of one or more of EngagementStageName, EngagementStageShortName and/or EngagementStageUid. However, if you do specify more than one, 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 EngagementStageUid will all be populated, and guaranteed to refer to a single engagement stage.

Format


PwsEngagementStageRef
  • PwsEngagementStageRef
    • EngagementStageId: Int32
    • EngagementStageName: String (50)
    • EngagementStageShortName: String (15)
    • EngagementStageUid: Int64


Elements


Element

Data Type

Required?

Description

Sample Data

EngagementStageId

Int32

No

The engagement stage Id is a unique identifier for an engagement stage. For internal use only.


EngagementStageName

String (50)

One of EngagementName, EngagementStageShortName or EngagementStageUid is required


The engagement stage name is a unique identifier for an engagement stage.

Open

EngagementStageShortName

String (15)

See EngagementStageName

The engagement stage short name is a unique identifier for an engagement stage.

Open

EngagementStageUid

Int64

See EngagementStageName


A unique and immutable identifier for an engagement stage.

1152921504606849675

Usage Example(s)


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