...
This web service retrieves a list of project contacts, based upon a unique project identifier (PwsProjectRef) and a list of result narrowing filters. The permission that grants the user access to the list of contacts is permission to access project's workspace home tab. The filters will control which specific types of contacts are included in the response, but the entire list of contacts consists of:
- The engagement manager
- The project manager
- Members of the project management team
- Resources booked on the project
- Resources requested on the project
- Client users associated with the project
- Users who own one or more issues on the project
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ARNkL4C1bp7KLtsSXQW6/g== | |
IncludeBookedResourcesFlag | Boolean | No | false | If set to 'true', booked/allocated resources of the project are included in the response. | true |
IncludeClientUsersFlag | Boolean | No | false | If set to 'true', client users of the project are included in the response. | true |
IncludeEmFlag | Boolean | No | false | If set to 'true', engagement manager of the project's engagement is included in the response. | true |
IncludeIssueOwnersFlag | Boolean | No | false | If set to 'true', owners of project issuesare included in the response. | true |
IncludePmFlag | Boolean | No | false | If set to 'true', project manager is included in the response. | true |
IncludePmTeamFlag | Boolean | No | false | If set to 'true', project management team members that are not project manager or engagement managers are included in the response. | true |
IncludeRequestedResourcesFlag | Boolean | No | false | If set to 'true', requested resources of the project are included in the response. | true |
ProjectIdentity | Yes | This structure represents the unique key fields associated with a project. Click here for more information. |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click herefor more information | ||
ResponseId | Int32 | Click here for more information. | 0 |
Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-07T20:00:44.2684248Z |
Contacts | The detailed information of the project contacts. Click here for more information. |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and WarningsWarning
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 23000 | ProjectIdentityRequiredForGetContacts | A project identity must be specified. |
| 54282 | ProjectNotFound | Specified project does not exist. |
...