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.
| Element | Data Type | Description | Default (on insert/update) | Sample Data |
|---|
| EngagementCode | String | This is the engagement code, which can uniquely identify a project |
| E001395 |
| EngagementId | Int32 | This is the engagement id. For internal use only |
|
|
| EngagementUid | Int64 | This is the unique identifier of an engagement |
| 1152921504607324698 |
Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Example 01 - EngagementCode Only |
|---|
| collapse | true |
|---|
|
<com:PwsEngagementRef>
<com:EngagementCode>E001395</com:EngagementCode>
<!--com:EngagementId>?</com:EngagementId-->
<!--com:EngagementUid>?</com:EngagementUid-->
</com:PwsEngagementRef> |
| Code Block |
|---|
| language | xml |
|---|
| title | Example 02 - EngagementCode and EngagementUid |
|---|
| collapse | true |
|---|
|
<com:PwsEngagementRef>
<com:EngagementCode>E001395</com:EngagementCode>
<!--com:EngagementId>?</com:EngagementId-->
<com:EngagementUid>1152921504607324698</com:EngagementUid>
</com:PwsEngagementRef> |