...
| 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 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 | 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 | 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. |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetEngagementTypeList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Aa/HJL2aAIqnCD1DEazq8Q==</req:SessionTicket>
<req:IncludeInactiveFlag>true</req:IncludeInactiveFlag>
<req:MaxRowsToReturn>3</req:MaxRowsToReturn>
</pws:serviceRequest>
</pws:PwsGetEngagementTypeList>
</soapenv:Body>
</soapenv:Envelope> |
...
| 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 |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | Description |
|---|---|---|
54612 | EngagementTypeNotFound | The specified engagement type does not exist. |