...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | ||
String (50) | Yes | Click here for more information | AavFwbZgVb9V4tr3R7BbzQ== | ||
EngagementIdentities | PwsEngagementRef [1..100] | Yes | One or more (up to 100) engagements to be retrieved. Click here for more information. |
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:PwsGetEngagement>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<sch:EngagementIdentities>
<com:PwsEngagementRef>
<com:EngagementCode>P001320</com:EngagementCode>
</com:PwsEngagementRef>
</sch:EngagementIdentities>
</pws:serviceRequest>
</pws:PwsGetEngagement>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
| Element | DataType | 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 | StringRequestStatus | Click here for more information | Ok |
| ServerTimestampUtc | DateTime | Click here for more information | 2018-01-17T19:38:01.0608747Z |
| Engagements | PwsEngagementElement [01..100] | The details of the engagements that were fetched. Click here for more information. |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 105 | AtLeastOneItemNotFound | One or more specified engagements not found |
| 12042 | NoEngagementsSpecified | No engagements specified for retrieval |
| 12044 | MaximumEngagementIdentitiesExceeded | Attempt to retrieve more than the maximum allowable number of engagements at once |
50045 | ViewPermissionDenied | Permission denied |
| 54059 | EngagementNotSpecified | A specified engagement reference was incomplete or missing |
| 54064 | UnexpectedErrorRetrievingEngagements | Unexpected error retrieving engagements |
| 54370 | NoPermissionToViewEngagement | Permission denied to view specific engagement |