...
- 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).
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | Ab54WRQ1LlgW9CoQrXhyzw== | |
EngagementIdentity | 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.
| true | |
MaxRowsToReturn | Int32 | No | The maximum number of engagements to be retrieved | 5 | |
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 | 2018-01-01 | |
PurchaseOrderNumber | String | No | The purchase order number(s) associated with the engagement(s) |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetEngagementList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Ab54WRQ1LlgW9CoQrXhyzw==</req:SessionTicket>
<sch:IncludeClosedFlag>true</sch:IncludeClosedFlag>
<sch:MaxRowsToReturn>5</sch:MaxRowsToReturn>
<sch:LastUpdatedSinceTimestamp>2018-01-01</sch:LastUpdatedSinceTimestamp>
</pws:serviceRequest>
</pws:PwsGetEngagementList>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsGetEngagementList>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>Ab54WRQ1LlgW9CoQrXhyzw==</req:SessionTicket>
<sch:EngagementIdentity>
<com:EngagementCode>P001320</com:EngagementCode>
</sch:EngagementIdentity>
<sch:IncludeClosedFlag>false</sch:IncludeClosedFlag>
</pws:serviceRequest>
</pws:PwsGetEngagementList>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|