Versions Compared

Key

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

...

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 Engagementengagement.

Format


Panel
titlePwsEngagementRef
  • PwsEngagementRef
    • EngagementCode: String
    • EngagementId: Int32
    • EngagementUid: Int64

...

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 engagement code is a unique identifier for an Engagementengagement

E001395

EngagementId

Int32

On Insert: No

On Update: No


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


EngagementUid

Int64

On Insert: No

On Update: Yes (if EngagementCode is not specified)


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

1152921504607324698

Usage Example(s)

...