Versions Compared

Key

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

Overview

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

Format

Panel
titlePwsEngagementSummaryPwsProjectSummary
  • PwsEngagementSummaryPwsProjectSummary
    • EngagementCodeProjectCode: String (2024)
    • EngagementIdProjectId: Int32
    • EngagementUidProjectUid: Int64
    • ClientIdentityEngagementIdentity: PwsClientRef PwsEngagementRef
    • EngagementNameProjectName: String (255)

Elements


Element

Data TypeRequired?

Default

Description

Sample Data

EngagementCodeProjectCode

String (20)

On Insert: Yes

On Update: Yes (if EngagementUid is not supplied24)

The engagement project code is a unique identifier for an engagementa project. See "NewEngagementCode" in PwsEngagementDetail for NewProjectCode" in PwsProjectDetail for guidance on how to change the engagement project code of an existing engagementproject

P001320P001053-001

EngagementIdProjectId

Int32

On Insert: No

On Update: No

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


EngagementUidProjectUid

Int64

On Insert: No

On Update: Yes (if EngagementCode is not supplied)

A unique and immutable identifier for an engagement.

1152921504607326368

1152921504607161597

ClientIdentity

PwsClientRef

On Insert: Yes

On Update: No

The client associated with the engagement

EngagementNameEngagementIdentity

PwsEngagementRef

The engagement that this project belongs to. Click here for more information.


ProjectName

String (255)On Insert: Yes

On Update: No

The engagement project name.

WebDon Services DocumentationCarlo (2010-2020)

Usage Example(s)

Code Block
languagexml
titleExample 01
collapsetrue
               <b:PwsEngagementSummary>PwsProjectSummary>
                  <b:EngagementCode>P001320<ProjectCode>P001052-001</b:EngagementCode>ProjectCode>
                  <b:EngagementIdProjectId i:nil="true"/>
                  <b:EngagementUid>1152921504607326368<ProjectUid>1152921504607161597</b:EngagementUid>ProjectUid>
                  <b:ClientIdentity>EngagementIdentity>
                     <b:ClientId i:nil="true"/>EngagementCode>P001052</b:EngagementCode>
                     <b:ClientNumber>C000121</b:ClientNumber>:EngagementId i:nil="true"/>
                     <b:ClientUid>1152921504606998462<EngagementUid>1152921504607090183</b:ClientUid>EngagementUid>
                  </b:ClientIdentity>EngagementIdentity>
                  <b:EngagementName>WebProjectName>Hello Services Documentation<Luke</b:EngagementName>ProjectName>
               </b:PwsEngagementSummary>PwsProjectSummary>