Versions Compared

Key

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

...

Panel
titlePwsGetEngagementTypeList Request

Request Element


rElement

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

SessionTicket

String

Yes 


Click here for more information.

Aa/HJL2aAIqnCD1DEazq8Q== 

EcCostCenterIdentity

PwsCostCenterRef

No 


For this service, if the cost center is specified, only engagement types that are valid for the cost center will be returned. Applicable to installations in which Enterprise Configuration is enabled.


EngagementTypeIdentity

PwsEngagementTypeRef

No 


For this service, the caller may specify up to 1 engagement type identity. If an engagement type identity is not specified all engagement types fitting the criteria will be returned.


IncludeInactiveFlag

Boolean

No 

true

If set to 'true', all engagement types including those that have been marked as inactive will be returned. This flag is disregarded if an engagement type is specified.

true

MaxRowsToReturn

Int32

No


The maximum number of engagement types to be returned. This value is disregarded if an engagement type is specified in EngagementTypeIdentity.

QueryString

String (255)

No 


A search string to narrow down the results. An engagement type will be included in the results if the search string matches the engagement type name or EngagementTypeShortName. This value is disregarded if a client is specified in EngagementTypeIdentity.


...