Overview
This web service retrieves a list of engagement summary records (PwsEngagementSummary), based on specified search criteria. The following parameters affect the list of engagements retrieved:
- QueryString. Find all engagements matching specified string in engagement name or engagement code, client name or code (for engagement's client and any of it's parent clients) or project name or code (for projects that are part of the engagement).
- IncludeClosedFlag. If true, engagements that are open or closed according to the current engagement stage settings will be returned. Otherwise, only engagements that are not considered closed will be returned.
- LastUpdatedSinceTimestamp. If specified, only engagements updated after the specified timestamp will be retrieved.
- PurchaseOrderNumber. If specified, only engagements with a purchase number that exactly matches the specified value will be retrieved.
- EngagementId/EngagementUid/EngagementCode. If specified, the identified engagement will be returned (QueryString, IncludeClosedFlag, LastUpdatedSinceTimestamp and PurchaseOrderNumber will be ignored).
| Info |
|---|
|
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior. |
Request Format
| Panel |
|---|
| title | PwsGetEngagementList Request |
|---|
|
- PwsGetEngagementList
- serviceRequest: PwsGetEngagementListRq
|
...