Overview
This web service retrieves a list of project role element records, based upon a list of unique project role identifiers (PwsProjectRoleRef).
Request Format
PwsGetProjectRole Request
PwsGetProjectRole
serviceRequest: PwsGetProjectRoleRq
RequestId: Int32
SessionTicket: String
ExcludeReadNotesFlag: Boolean
Mode: String
ProjectRoleIdentities: PwsProjectRoleRef [1-100]
Request Elements
Element | Data Type | Required? | Default | Description | Example Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | |||
String | Yes | Click here for more information |
| ||
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. |
|
Mode | String | Yes | Applies if FullDetailFlag is set to true: A to retrieve booked data for roles R to retrieve requested data for roles E to retrieve effective data for roles (booked data for booked roles, requested data for requested roles) |
| |
ProjectRoleIdentities | PwsProjectRoleRef [1-100] | This structure represents the unique key fields associated with identifying a project role. A role represents demand for labor. This demand is then supplied by a resource assigned to the role. For example, project X needs a social media director which will be staffed by Henry. Roles are booked hours so that the resource and you know who is working on what and when. Project roles can be identified by an ExternalSystemIdentifier or ProjectRoleUid. When specifying a PwsProjectRoleRef as an input to a web service, you may specify one or both the ExternalSystemIdentifier and ProjectRoleUid. However, if you do specify both, they must both refer to the same project role or the project role reference will not be considered valid. When a PwsProjectRoleRef is returned in the response to a web service, both the ExternalSystemIdentifier and ProjectRoleUid will be populated, and guaranteed to refer to a single project role. |
Request Usage Example(s)
<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:PwsGetProjectRole>
<pws:serviceRequest>
<req:SessionTicket>AfCYcj5TI7kC06MRlX2MZQ==</req:SessionTicket>
<sch:ExcludeReadNotesFlag>false</sch:ExcludeReadNotesFlag>
<sch:Mode>A</sch:Mode>
<sch:ProjectRoleIdentities>
<com:PwsProjectRoleRef>
<com:ProjectRoleUid>1152921504611130917</com:ProjectRoleUid>
</com:PwsProjectRoleRef>
</sch:ProjectRoleIdentities>
</pws:serviceRequest>
</pws:PwsGetProjectRole>
</soapenv:Body>
</soapenv:Envelope>
Response Format
PwsGetProjectRole Response
PwsGetProjectRoleResponse
PwsGetProjectRoleResult: PwsGetProjectRoleRs
Messages: PwsMessage [1-100]
ResponseId: Int32
Status: RequestStatus
ServerTimestampUtc: DateTime
ProjectRoles: PwsProjectRoleElement [1-100]
ProjectSummaries: PwsProjectRoleProjectSummary [1-100]
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | PwsMessage [1-100] | The web service response status and message. Click here for more information. | |
Int32 | Click here for more information |
| |
RequestStatus | Click here for more information. |
| |
DateTime | Click here for more information. |
| |
ProjectRoles | PwsProjectRoleElement [1-100] | This structure contains an instance of PwsProjectRoleDetail which completely defines a project role. | |
ProjectSummaries | PwsProjectRoleProjectSummary [1-100] | The basic information of a project role. |
Response Usage Example(s)
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsGetProjectRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsGetProjectRoleResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/></Messages>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2024-10-10T20:49:16.8718067Z</ServerTimestampUtc>
<a:ProjectRoles xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsProjectRoleElement>
<b:ProjectRoleDetail>
<b:ExternalSystemIdentifier i:nil="true"/>
<b:ProjectRoleId i:nil="true"/>
<b:ProjectRoleUid>1152921504611130917</b:ProjectRoleUid>
<b:BaseRateOnTitleIdentity i:nil="true"/>
<b:CandidateIdentities>
<b:PwsResourceRef>
<b:ResourceDisplayName>Matt</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>Manager - MJ</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607057128</b:ResourceUid>
</b:PwsResourceRef>
</b:CandidateIdentities>
<b:CostCenterAnyFlag>true</b:CostCenterAnyFlag>
<b:CostCenterCriteria i:nil="true" xmlns:c="http://projectorpsa.com/CommonServices/"/>
<b:CostCenterIdentity i:nil="true"/>
<b:DefaultSchedulingMode>W</b:DefaultSchedulingMode>
<b:Description>Today is 9/24/2024It is a rainy day</b:Description>
<b:Keywords i:nil="true"/>
<b:LocationAnyFlag>true</b:LocationAnyFlag>
<b:LocationIdentities i:nil="true"/>
<b:LocationIdentity i:nil="true"/>
<b:NewExternalSystemIdentifier i:nil="true"/>
<b:ResourceIdentity>
<b:ResourceDisplayName>Matt</b:ResourceDisplayName>
<b:ResourceId i:nil="true"/>
<b:ResourceReferenceSystemId>Manager - MJ</b:ResourceReferenceSystemId>
<b:ResourceUid>1152921504607057128</b:ResourceUid>
</b:ResourceIdentity>
<b:RoleEndDate i:nil="true"/>
<b:RoleName>Matt</b:RoleName>
<b:RoleStartDate i:nil="true"/>
<b:ShareCostCenterIdentity i:nil="true"/>
<b:SkillCriteria i:nil="true"/>
<b:TitleIdentities i:nil="true"/>
<b:TitleIdentity i:nil="true"/>
<b:RdcTransferCurrencyIdentity i:nil="true"/>
<b:RdcTransferHourlyRate i:nil="true"/>
<b:RevenueTransferHourlyRate i:nil="true"/>
<b:UserDefinedFields/>
<b:RateExceptions/>
<b:RdcExceptions/>
<b:InheritPurchaseOrderNumberFlag>false</b:InheritPurchaseOrderNumberFlag>
<b:PurchaseOrderNumber i:nil="true"/>
<b:ResourceTypeAnyFlag>true</b:ResourceTypeAnyFlag>
<b:ResourceTypeIdentities i:nil="true"/>
<b:ResourceTypeIdentity i:nil="true"/>
<b:ShareUserIdentity i:nil="true"/>
<b:Timestamp>AAAAADV6NEI=</b:Timestamp>
<b:RoleTypeIdentity i:nil="true"/>
</b:ProjectRoleDetail>
<b:AssignedToSchedulersFlag>false</b:AssignedToSchedulersFlag>
<b:Notes/>
<b:ProjectIdentity>
<b:ProjectCode>E001057-P001</b:ProjectCode>
<b:ProjectId i:nil="true"/>
<b:ProjectUid>1152921504607670227</b:ProjectUid>
</b:ProjectIdentity>
<b:CurrentResourceCostCenterIdentity>
<b:CostCenterId i:nil="true"/>
<b:CostCenterName>PPSA - Management</b:CostCenterName>
<b:CostCenterNumber>PPSA - Management</b:CostCenterNumber>
<b:CostCenterUid>1152921504606892905</b:CostCenterUid>
</b:CurrentResourceCostCenterIdentity>
<b:CurrentResourceLocationIdentity>
<b:LocationId i:nil="true"/>
<b:LocationName>USA - Massachusetts</b:LocationName>
<b:LocationUid>1152921504606855985</b:LocationUid>
</b:CurrentResourceLocationIdentity>
<b:CurrentResourceResourceTypeIdentity>
<b:ResourceTypeCode>FTE</b:ResourceTypeCode>
<b:ResourceTypeId i:nil="true"/>
<b:ResourceTypeName>Full Time Employee</b:ResourceTypeName>
<b:ResourceTypeUid>1152921504606847348</b:ResourceTypeUid>
</b:CurrentResourceResourceTypeIdentity>
<b:CurrentResourceTitleIdentity>
<b:DepartmentIdentity>
<b:DepartmentId i:nil="true"/>
<b:DepartmentName>Management Team</b:DepartmentName>
<b:DepartmentUid>1152921504606854180</b:DepartmentUid>
</b:DepartmentIdentity>
<b:TitleId i:nil="true"/>
<b:TitleName>Level 2</b:TitleName>
<b:TitleUid>1152921504606876418</b:TitleUid>
</b:CurrentResourceTitleIdentity>
<b:DeletedFlag>false</b:DeletedFlag>
<b:EarliestAllowableEndDate i:nil="true"/>
<b:EffectiveCriteriaSet>A</b:EffectiveCriteriaSet>
<b:InheritedPurchaseOrderNumber>WS-001</b:InheritedPurchaseOrderNumber>
<b:LatestAllowableStartDate i:nil="true"/>
<b:RoleStatus>N</b:RoleStatus>
<b:TotalScheduledMinutes>0</b:TotalScheduledMinutes>
<b:UnnamedCriteriaCompleteFlag>false</b:UnnamedCriteriaCompleteFlag>
</b:PwsProjectRoleElement>
</a:ProjectRoles>
<a:ProjectSummaries xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsProjectRoleProjectSummary>
<b:ProjectCode>E001057-P001</b:ProjectCode>
<b:ProjectId i:nil="true"/>
<b:ProjectUid>1152921504607670227</b:ProjectUid>
<b:EngagementIdentity>
<b:EngagementCode>E001057</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504608136769</b:EngagementUid>
</b:EngagementIdentity>
<b:ProjectName>Regression Testing: Web Services A</b:ProjectName>
<b:CcBasedManagementTeam/>
<b:Client>
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000155</b:ClientNumber>
<b:ClientUid>1152921504607011919</b:ClientUid>
<b:ClientName>Web Services Inc.</b:ClientName>
<b:InactiveFlag>false</b:InactiveFlag>
<b:ParentClientIdentity i:nil="true"/>
</b:Client>
<b:EngagementTypeIdentity>
<b:EngagementTypeId i:nil="true"/>
<b:EngagementTypeName>Billable - Time and Materials</b:EngagementTypeName>
<b:EngagementTypeShortName>TandM</b:EngagementTypeShortName>
<b:EngagementTypeUid>1152921504606863884</b:EngagementTypeUid>
</b:EngagementTypeIdentity>
<b:ManagementTeam/>
<b:Manager>
<b:UserDisplayName>Bettina</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>QA - BB</b:UserReferenceSystemId>
<b:UserUid>1152921504607011056</b:UserUid>
<b:EmailAddress>bettina@projectorpsa.com</b:EmailAddress>
<b:FirstName>Bettina</b:FirstName>
<b:LastName>Borces</b:LastName>
<b:MiddleName i:nil="true"/>
</b:Manager>
<b:ProjectCloseDate i:nil="true"/>
<b:ProjectOpenDate>2024-05-01T00:00:00</b:ProjectOpenDate>
</b:PwsProjectRoleProjectSummary>
</a:ProjectSummaries>
</PwsGetProjectRoleResult>
</PwsGetProjectRoleResponse>
</s:Body>
</s:Envelope>
PwsGetProjectRoleResponse - Common Errors and Warnings
For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
54583 | InvalidValueForMode | The value specified for mode is invalid. Valid values are R for Request, A for Allocate and E for Effective (for retrieval operations only). |
105 | AtLeastOneItemNotFound | At least one requested item was not found. The remaining items, if any, were returned. |