Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Current »

Overview

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


PwsGetProjectContacts Request
  • PwsGetProjectContacts
    • serviceRequest: PwsGetProjectContactsRq
      • RequestId: Int32
      • SessionTicket: String
      • IncludeBookedResourcesFlag: Boolean
      • IncludeClientUsersFlag: Boolean
      • IncludeEmFlag: Boolean
      • IncludeIssueOwnersFlag: Boolean
      • IncludePmFlag: Boolean
      • IncludePmTeamFlag: Boolean
      • IncludeRequestedResourcesFlag: Boolean
      • ProjectIdentity: PwsProjectRef

Request 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.

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 issues are 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

PwsProjectRef

Yes


This structure represents the unique key fields associated with a project. Click here for more information.


Request Usage Example(s)


Example 01 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProjectContacts>
         <pws:serviceRequest>
            <req:SessionTicket>ARNkL4C1bp7KLtsSXQW6/g==</req:SessionTicket>
            <web:IncludeBookedResourcesFlag>true</web:IncludeBookedResourcesFlag>
            <web:IncludeClientUsersFlag>true</web:IncludeClientUsersFlag>
            <web:IncludeEmFlag>true</web:IncludeEmFlag>
            <web:IncludeIssueOwnersFlag>true</web:IncludeIssueOwnersFlag>
            <web:IncludePmFlag>true</web:IncludePmFlag>
            <web:IncludePmTeamFlag>true</web:IncludePmTeamFlag>
            <web:IncludeRequestedResourcesFlag>true</web:IncludeRequestedResourcesFlag>
            <web:ProjectIdentity>
               <com:ProjectCode>P001053-001</com:ProjectCode>
            </web:ProjectIdentity>
         </pws:serviceRequest>
      </pws:PwsGetProjectContacts>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


PwsGetProjectContacts Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage

The web service response status and message. Click herefor more information


ResponseId

Int32

Click here for more information.

0

Status

RequestStatusClick here for more informationOk

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-07T20:00:44.2684248Z

Contacts

PwsProjectContact

The detailed information of the project contacts. Click here for more information.



Response Usage Example(s)

Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectContactsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectContactsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-07T20:00:44.2684248Z</ServerTimestampUtc>
            <a:Contacts>
               <a:PwsProjectContact>
                  <a:ClientIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:Contact xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Larry Krakauer</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944254</b:UserUid>
                  </a:Contact>
                  <a:EmailAddress>Larry@revcorp.min.cnv1</a:EmailAddress>
                  <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:LocationId i:nil="true"/>
                     <b:LocationName>Springfield</b:LocationName>
                     <b:LocationUid>1152921504606850978</b:LocationUid>
                  </a:LocationIdentity>
                  <a:MobilePhone i:nil="true"/>
                  <a:OfficePhone>(617) 383-0832</a:OfficePhone>
                  <a:OtherContactInformation>AIM: lkrak
MSN: larry@revcorp.org</a:OtherContactInformation>
                  <a:Roles>
                     <a:PwsContactRole>
                        <a:ProjectRoleIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:RoleName>Project Manager</a:RoleName>
                     </a:PwsContactRole>
                  </a:Roles>
                  <a:TitleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:DepartmentIdentity>
                        <b:DepartmentId i:nil="true"/>
                        <b:DepartmentName>Management</b:DepartmentName>
                        <b:DepartmentUid>1152921504606851319</b:DepartmentUid>
                     </b:DepartmentIdentity>
                     <b:TitleId i:nil="true"/>
                     <b:TitleName>Managing Partner</b:TitleName>
                     <b:TitleUid>1152921504606862839</b:TitleUid>
                  </a:TitleIdentity>
               </a:PwsProjectContact>
               <a:PwsProjectContact>
                  <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:ClientId i:nil="true"/>
                     <b:ClientNumber>C000111</b:ClientNumber>
                     <b:ClientUid>1152921504606906284</b:ClientUid>
                  </a:ClientIdentity>
                  <a:Contact xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Peter Gelb</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId i:nil="true"/>
                     <b:UserUid>1152921504607005072</b:UserUid>
                  </a:Contact>
                  <a:EmailAddress>peter@metopera.org.cnv1</a:EmailAddress>
                  <a:LocationIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:MobilePhone i:nil="true"/>
                  <a:OfficePhone i:nil="true"/>
                  <a:OtherContactInformation i:nil="true"/>
                  <a:Roles>
                     <a:PwsContactRole>
                        <a:ProjectRoleIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:RoleName>Issue Owner</a:RoleName>
                     </a:PwsContactRole>
                  </a:Roles>
                  <a:TitleIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
               </a:PwsProjectContact>
               <a:PwsProjectContact>
                  <a:ClientIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:Contact xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Ronni Skerker</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>030</b:UserReferenceSystemId>
                     <b:UserUid>1152921504606944264</b:UserUid>
                  </a:Contact>
                  <a:EmailAddress>Ronni@revcorp.cnv</a:EmailAddress>
                  <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:LocationId i:nil="true"/>
                     <b:LocationName>Springfield</b:LocationName>
                     <b:LocationUid>1152921504606850978</b:LocationUid>
                  </a:LocationIdentity>
                  <a:MobilePhone>(617) 246-0312</a:MobilePhone>
                  <a:OfficePhone>(617) 383-0878</a:OfficePhone>
                  <a:OtherContactInformation>AIM: rswork02341</a:OtherContactInformation>
                  <a:Roles>
                     <a:PwsContactRole>
                        <a:ProjectRoleIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:RoleName>Engagement Manager</a:RoleName>
                     </a:PwsContactRole>
                  </a:Roles>
                  <a:TitleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:DepartmentIdentity>
                        <b:DepartmentId i:nil="true"/>
                        <b:DepartmentName>Management</b:DepartmentName>
                        <b:DepartmentUid>1152921504606851319</b:DepartmentUid>
                     </b:DepartmentIdentity>
                     <b:TitleId i:nil="true"/>
                     <b:TitleName>Managing Partner</b:TitleName>
                     <b:TitleUid>1152921504606862839</b:TitleUid>
                  </a:TitleIdentity>
               </a:PwsProjectContact>
            </a:Contacts>
         </PwsGetProjectContactsResult>
      </PwsGetProjectContactsResponse>
   </s:Body>
</s:Envelope>


PwsGetProject - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

23000ProjectIdentityRequiredForGetContactsA project identity must be specified.
54282ProjectNotFoundSpecified project does not exist.
  • No labels