...
This web service retrieves a list of project element records (PwsProjectElement), based upon a list of unique project identifiers (PwsProjectRef).
Note: The response to this service by default includes also the full details of a number of sub-entities related to projects on a one-to-many basis, namely Project Roles, Project Rate Types, Project Task Types, and Project Tasks. If you don't need that data, please simplify your request by using the ExcludeSubEntityElementsFlagparameter, which will also cause the service to operate faster and with greater efficiency.
If you only need information about one or two of these sub-entities, please consider as an alternative the simpler, faster, and more efficient services:
PwsGetProjectRoles: a collection of all project roles grouped by project
PwsGetProjectRateTypes: a collection of all project rate types grouped by project.
PwsGetProjectTaskTypes: a collection of all project task types grouped by project.
PwsGetProjectTasks: a collection of all project tasks grouped by project.
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | ||
String (50) | Yes | Click here for more information | AW1yokY4MDImXfp9pM5NRw== | ||
| Mode | String (1) | Yes | The mode determines which set of criteria is returned in the response. "R": Requested criteria are returned "A": Booked criteria are returned "E": Effective criteria (requested criteria for requested roles and booked criteria for booked roles) are returned. | R/A/E | |
ProjectIdentities | PwsProjectRef [0..100] | Yes | The identities of the projects to be retrieved. | ||
| ExcludeReadNotesFlag | Boolean | No | false | If true, notes that have been marked as read by the current user are excluded from the data returned. Applies only when FullDetailFlag is true. | |
| IncludeDeletedRolesFla | Boolean | No | false | If set to true, deleted roles will be included in the response. | 0 |
| ExcludeSubEntityElementsFlag | Boolean | No | false | If set to true, subentities information is not included in the response. |
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:PwsGetProject>
<pws:serviceRequest>
<req:SessionTicket>AW1yokY4MDImXfp9pM5NRw==</req:SessionTicket>
<sch:Mode>R</sch:Mode>
<sch:ProjectIdentities>
<com:PwsProjectRef>
<com:ProjectCode>P001012-002</com:ProjectCode>
</com:PwsProjectRef>
</sch:ProjectIdentities>
</pws:serviceRequest>
</pws:PwsGetProject>
</soapenv:Body>
</soapenv:Envelope>
|
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
| Messages | PwsMessage[] | The web service response status and message. Click here for more information. | |
| RequestIdResponseId | Int32 | Click Click here for more information. | 1 |
Status | RequestStatus | Click here for more information. | Ok |
String | Click here for more information. | 2018-01-17T19:44:09.3975552Z | |
Projects | The details of the projects that were fetched. Click here for more information. |
...