Overview

This structure is used to uniquely identify an engagement. Engagements can be identified by EngagementCode or EngagementUid. When specifying a PwsEngagementRef as an input to a web service, you may specify one or both the EngagementCode and/or EngagementUid. However, if you do specify both, they must both refer to the same engagement or the engagement reference will not be considered valid. When a PwsEngagementRef is returned in the response to a web service, both the EngagementCode and EngagementUid will be populated, and guaranteed to refer to a single Engagement.

Format

PwsEngagementRef

PwsEngagementRef
- EngagementCode: String
- EngagementId: Int32
- EngagementUid: Int64

Element

Data Type

Required?

Default

Description

Sample Data

EngagementCode

String

On Insert: No

On Update: Yes (if EngagementUid is not specified)

The Engagement Code is a unique identifier for an Engagement

E001395

EngagementId

Int32

On Insert: No

On Update: No

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

EngagementUid

Int64

On Insert: No

On Update: Yes (if EngagementCode is not specified)

The Engagement Uid is a unique and immutable identifier for an Engagement

1152921504607324698

Usage Example(s)

Example 01 - EngagementCode Only

               <com:PwsEngagementRef>
                  <com:EngagementCode>E001395</com:EngagementCode>
                  <!--com:EngagementId>?</com:EngagementId-->
                  <!--com:EngagementUid>?</com:EngagementUid-->
               </com:PwsEngagementRef>

Example 02 - EngagementCode and EngagementUid

                <com:PwsEngagementRef>
                  <com:EngagementCode>E001395</com:EngagementCode>
                  <!--com:EngagementId>?</com:EngagementId-->
                  <com:EngagementUid>1152921504607324698</com:EngagementUid>
               </com:PwsEngagementRef>