...
This web service retrieves a list of engagement project summary records (PwsEngagementSummaryPwsProjectSummary), based on specified search criteria. The following parameters affect the list of engagements retrieved:
- QueryString. : Find all engagements projects matching specified string in engagement name or engagement code, in project's code or name, associated contract line item code or name, the associated engagement code or name, or the client name or code (number for the associated engagement's client and or any of it's parent clients) or project name or code (for projects that are part of the engagement)parent client thereof.
- IncludeClosedFlag. : If set to 'true', engagements projects that are open or closed according to the current engagement project stage settings will be returned. Otherwise, only engagements projects that are considered not considered closed will be returned.
- EngagementId/EngagementUid/EngagementCode. ProjectIdentity: If specified, the identified engagement will be returned (. And QueryString and IncludeClosedFlag will be ignored).
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
ElementctElement | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ||
IncludeClosedFlag | Boolean | No | false | If set to 'true', projects that are open or closed according to the project stage settings will be returned. Otherwise, only projects that are considered not closed will be returned. This flag is disregarded if a project is specified in ProjectIdentity. | false |
MaxRowsToReturn | Int32 | No | The maximum number of projects to be retrieved. This flag is disregarded if a project is specified in ProjectIdentity. | 10 | |
ProjectIdentity | No | The unique keys used to identify projects(s) to be retrieved. Click here for more information. | |||
QueryString | String | No | A search string to narrow down the results. A project will be included in the results if the search string matches the project's code or name, of if it matches the associated contract line item code or name, or if it matches the associated engagement code or name, of if it matches the client name or number for the associated engagement's client or any parent client thereof, or if it matches the contract line item name or code or project name or code of any contract line item or project contained in the engagement. This value is disregarded if a project is specified in ProjectIdentity. | P001053-001|P001053-002 | |
LastUpdatedSinceTimestamp | DateTime | No | Only projects that have been updated on or after the specified date/time will be retrieved. This value is disregarded if a project is specified in ProjectIdentity. | 2018-01-01z |
...