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
| Panel | ||
|---|---|---|
| ||
|
Element
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
EngagementCode | String (20) | 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)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<com:PwsEngagementRef>
<com:EngagementCode>E001395</com:EngagementCode>
</com:PwsEngagementRef> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<com:PwsEngagementRef>
<com:EngagementCode>E001395</com:EngagementCode>
<com:EngagementUid>1152921504607324698</com:EngagementUid>
</com:PwsEngagementRef> |