...
- QueryString. Find all engagement types matching specified string in engagement type name or engagement type short name
- IncludeInactiveFlag. If true, engagement type types that are marked as inactive will be returned. Otherwise, only engagement types that are not considered inactive will be returned.
- EcCostCenterIdentity. If you specify a cost center in this parameter, then the enterprise configuration settings for this cost center will have a bearing on whether each engagement type is considered inactive or not. If an engagement type is not allowed for the specified cost center, it will be treated as inactive. If no cost center is specified, only the engagement type's inactive setting is used to determine if the engagement type is considered inactive. Note that this only has a bearing on the results when IncludeInactiveFlag is 'false'.
- EngagementTypeIdentity. If an engagement type is explicitly specified, only the identified engagement eypte type will be returned (QueryString, IncludeActiveFlag and IncludeActiveFlag EcCostCenterIdentity will be ignored).
Request Format
...
| Panel | ||
|---|---|---|
| ||
|
Request Element
rElement | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | Aa/HJL2aAIqnCD1DEazq8Q== | |
EcCostCenterIdentity | No | For this service, if the If a cost center is specified, only engagement types that are valid for the cost center (and are themselves marked active) will be returnedconsidered active for filtering purposes. Applicable to installations in which Enterprise Configuration is enabled. This only has an effect on the results if IncludeInactiveFlag is 'false'. | |||
EngagementTypeIdentity | 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. | 3 | |
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 EngagementTypeName or EngagementTypeShortName. This value is disregarded if a client an engagement type is specified in EngagementTypeIdentity. |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-02-28T20:58:20.9857123Z |
EngagementTypes | The engagement type summary record(s) retrieved by the service |
...