Overview

This structure represents the unique key fields associated with identifying an engagement type. Engagement Types can be identified by EngagementTypeName, EngagementTypeShortName or EngagementTypeUid. When specifying a PwsEngagementTypeRef as an input to a web service, you may specify any combination of the three fields. However, all specified fields must refer to the same engagement type or the engagement type reference will not be considered valid. When a PwsEngagementRef is returned in the response to a web service, the EngagementTypeName, EngagementTypeShortName and EngagementTypeUid will be populated, and guaranteed to refer to a single engagement type.

In association with PwsSaveEngagement here are the rules:

If an Engagement Type is specified by ID, UID, name or short name, use it
Otherwise, the following rules will be in effect:
- Select the first active, engagement type ordered by name
  - If enterprise configuration is in place, select the first active and "allowed" engagement type ordered by name
Otherwise, throw an error

Format

PwsEngagementTypeRef

PwsEngagementTypeRef
- EngagementTypeId: Int32
- EngagementTypeName: String (50)
- EngagementTypeShortName: String (15)
- EngagementTypeUid: Int64

Elements

Element	Data Type	Required?	Description	Sample Data
EngagementTypeId	Int32	No	The engagement type Id is a unique identifier for an engagement type. For internal use only.
EngagementTypeName	String (50)	One of EngagementTypeName, EngagementTypeShortName or EngagementTypeUid is required	The engagement type name is a unique identifier for an engagement type.	Executive - Contract Type
EngagementTypeShortName	String (15)	See EngagementTypeName	The engagement type short name is a unique identifier for an engagement type.	ECT
EngagementTypeUid	Int64	See EngagementTypeName	A unique and immutable identifier for an engagement type.	1152921504606873528

Usage Example(s)

Example 01

                     <b:EngagementTypeIdentity>
                        <b:EngagementTypeId i:nil="true"/>
                        <b:EngagementTypeName>Executive - Contract Type</b:EngagementTypeName>
                        <b:EngagementTypeShortName>ECT</b:EngagementTypeShortName>
                        <b:EngagementTypeUid>1152921504606873528</b:EngagementTypeUid>
                     </b:EngagementTypeIdentity>

Browser not supported