Versions Compared

Key

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

...

Panel
titlePwsGetEngagementList 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 marked as 'Closed' will be included in the response

 


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)