Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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.
  • EngagementId/EngagementUid/EngagementCode. If specified, the identified engagement will be returned (QueryString and IncludeClosedFlag will be ignored).

Format


PwsGetEngagementList Request
  • PwsGetEngagementList
    • serviceRequest: PwsGetEngagementListRq
      • RequestId: Int32
      • SessionTicket: String
      • EngagementIdentity: PwsEngagementRef
      • IncludeClosedFlag: Boolean
      • MaxRowsToReturn: Int32
      • QueryString: String
      • LastUpdatedSinceTimestamp: DateTime
      • PurchaseOrderNumber: String

Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.


EngagementIdentity

PwsEngagementRef

No 


The unique keys used to identify the engagement(s) to be retrieved


IncludeClosedFlag

Boolean

Yes 


If set to '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.

  • EngagementId/EngagementUid/EngagementCode. If specified, the identified engagement will be returned (QueryString and IncludeClosedFlag will be ignored).


MaxRowsToReturn

Int32

No 


The maximum number of engagements to be retrieved


QueryString

String

No 


The engagements that are returned will contain the value in this field


LastUpdatedSinceTimestamp

DateTime

No 


Only engagements that have been updated on or after the specified date/time will be retrieved


PurchaseOrderNumber

String

No 


The purchase order number(s) associated with the engagement(s)


  • No labels