Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This structure is used to uniquely identify an Engagementengagement. 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 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 Engagementengagement.

Format


Panel
titlePwsEngagementRef
  • PwsEngagementRef
    • EngagementCode: String (20)
    • EngagementId: Int32
    • EngagementUid: Int64

...

Elements


Element

Data Type

Required?

Default

Description

Sample Data

EngagementCode

String

 

 

The Engagement Code

(20)

One of EngagementCode or EngagementUid is required


The engagement code is a unique identifier for an

Engagement

engagement.

E001395

EngagementId

Int32

 

 

No

The

Engagement

engagement Id is a unique identifier for an

Engagement

engagement. For internal use only.


EngagementUid

Int64

 

 

The Engagement Uid is a

See EngagementCode

A unique and immutable identifier for an

Engagement

engagement.

1152921504607324698

Usage Example(s)


Code Block
languagexml
titleExample 01 - EngagementCode Only
collapsetrue
               <com:PwsEngagementRef>
                  <com:EngagementCode>E001395</com:EngagementCode>
                  <!--com:EngagementId>?</com:EngagementId-->
 
                <!--com:EngagementUid>?</com:EngagementUid-->
               </com:PwsEngagementRef>
Code Block
languagexml
titleExample 02 - EngagementCode and EngagementUid
collapsetrue
                <com:PwsEngagementRef>
                  <com:EngagementCode>E001395</com:EngagementCode>
                  <!--com:EngagementId>?</com:EngagementId-->
                  <com:EngagementUid>1152921504607324698</com:EngagementUid>
               </com:PwsEngagementRef>