/
PwsEngagementRef

PwsEngagementRef

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


PwsEngagementRef
  • PwsEngagementRef
    • EngagementCode: String (20)
    • EngagementId: Int32
    • EngagementUid: Int64

Elements


Element

Data Type

Required?

Description

Sample Data

EngagementCode

String (20)

One of EngagementCode or EngagementUid is required


The engagement code is a unique identifier for an engagement.

E001395

EngagementId

Int32

No

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


EngagementUid

Int64

See EngagementCode

A unique and immutable identifier for an engagement.

1152921504607324698

Usage Example(s)


Example 01 - EngagementCode Only
               <com:PwsEngagementRef>
                  <com:EngagementCode>E001395</com:EngagementCode>
               </com:PwsEngagementRef>
Example 02 - EngagementCode and EngagementUid
                <com:PwsEngagementRef>
                  <com:EngagementCode>E001395</com:EngagementCode>
                  <com:EngagementUid>1152921504607324698</com:EngagementUid>
               </com:PwsEngagementRef>

Related content

PwsEngagementDetail
PwsEngagementDetail
More like this
PwsProjectDetail
PwsProjectDetail
Read with this
PwsEngagementSummary
PwsEngagementSummary
More like this
PwsSaveProject
PwsSaveProject
Read with this
PwsEngagementTypeRef
PwsEngagementTypeRef
More like this
PwsInvoiceDetail
PwsInvoiceDetail
Read with this