Versions Compared

Key

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

...

  • 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 IncludeClosedFlag PurchaseOrderNumber will be ignored).

Request Format

...

Panel
titlePwsGetEngagementList Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

1

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-01-19T16:51:13.0252909Z

Engagements

PwsEngagementSummary[]

The engagement summary records that were fetched by the service


...