Overview

The PwsEngagementSummary data type includes basic information about an engagement. The information represented in this structure is not comprehensive and only includes certain key attributes of an engagement to be useful in a listing of engagements.

Format

PwsEngagementSummary

PwsEngagementSummary
- EngagementCode: String (20)
- EngagementId: Int32
- EngagementUid: Int64
- ClientIdentity: PwsClientRef
- EngagementName: String (255)

Elements

Element	Data Type	Required?	Description	Sample Data
EngagementCode	String (20)	On Insert: Yes On Update: Yes (if EngagementUid is not supplied)	The engagement code is a unique identifier for an engagement. See "NewEngagementCode" in PwsEngagementDetail for guidance on how to change the engagement code of an existing engagement.	P001320
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 supplied)	The engagement Uid is a unique and immutable identifier for an engagement	1152921504607326368
ClientIdentity	PwsClientRef	On Insert: Yes On Update: No	The client associated with the engagement. Click here for more information.
EngagementName	String (255)	On Insert: Yes On Update: No	The engagement name	Web Services Documentation

Usage Example(s)

Example 01

              <b:PwsEngagementSummary>
                  <b:EngagementCode>P001320</b:EngagementCode>
                  <b:EngagementId i:nil="true"/>
                  <b:EngagementUid>1152921504607326368</b:EngagementUid>
                  <b:ClientIdentity>
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000121</b:ClientNumber>
                     <b:ClientUid>1152921504606998462</b:ClientUid>
                  </b:ClientIdentity>
                  <b:EngagementName>Web Services Documentation</b:EngagementName>
               </b:PwsEngagementSummary>