Overview

This web service inserts or updates a single project role based on a detailed project role structure (PwsProjectRoleDetail). The service returns the identity (PwsProjectRoleRef) of the project role that has been inserted or updated.

Request Format

PwsSaveProjectRole Request

PwsSaveProjectRole
- serviceRequest: PwsSaveProjectRoleRq
  - RequestId: Int32
  - SessionTicket: String
  - BaseRatesOnTitleClearFlag: Boolean
  - CandidatesClearFlag: Boolean
  - CostCenterClearFlag: Boolean
  - CostCenterCriteriaClearFlag: Boolean
  - DescriptionClearFlag: Boolean
  - EngagementTimestamp: String
  - KeywordsClearFlag: Boolean
  - LocationClearFlag: Boolean
  - LocationCriteriaClearFlag: Boolean
  - Mode: String (1)
  - ProjectIdentity: PwsProjectRef
  - ProjectRole: PwsProjectRoleDetail
  - ResourceClearFlag: Boolean
  - RoleEndDateClearFlag: Boolean
  - RoleStartDateClearFlag: Boolean
  - ShareCostCenterClearFlag: Boolean
  - SkillCriteriaClearFlag: Boolean
  - StealLockFlag: Boolean
  - TitleClearFlag: Boolean
  - TitleCriteriaClearFlag: Boolean
  - RdcTransferHourlyRateClearFlag: Boolean
  - RevenueTransferHourlyRateClearFlag: Boolean
  - RateExceptionsClearFlag: Boolean
  - RdcExceptionsClearFlag: Boolean

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.	Ae9v30fDNwFMx833f5Hesg==
BaseRatesOnTitleClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing base-rate-on-title setting will be cleared and is set to basing rate on resource's title. BaseRateOnTitleIdentity in PwsProjectRoleDetail must be undefined*; if set to 'false', base-rate-on-title will be updated if BaseRateOnTitleIdentity provided in PwsProjectRoleDetail.	false
CandidatesClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing named candidates will be cleared and candidate identities defined in PwsProjectRoleDetail is ignored; If set to 'false', candidates will be updated if identities are provided in PwsProjectRoleDetail.	false
CostCenterClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', preferred cost center for unnamed candidate is cleared and preferred cost center identity defined in PwsProjectRoleDetail is ignored; If set to 'false', preferred cost center identities will be updated if provided in PwsProjectRoleDetail.	false
CostCenterCriteriaClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', cost center criteria for unnamed candidate is cleared and cost center criteria defined in PwsProjectRoleDetail is ignored; If set to 'false', cost center criteria will be updated if provided in PwsProjectRoleDetail.	false
DescriptionClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing description will be cleared. Description in PwsProjectRoleDetail must be undefined*; if set to 'false', description will be updated if provided in PwsProjectRoleDetail.	false
EngagementTimestamp	String	No		This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a prior call to PwsSaveProjectRole. This will cause the request to fail if any change has been made between invocations of PwsSaveProjectRole.
KeywordsClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing keywords for unnamed candidate is cleared. Keywords in PwsProjectRoleDetail must be undefined*; If set to 'false', keywords will be updated if provided in PwsProjectRoleDetail.	false
LocationClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', preferred location for unnamed candidate is cleared. LocationIdentity in PwsProjectRoleDetail must be undefined*; If set to 'false', preferred location will be updated if provided in PwsProjectRoleDetail. Please note, if System Settings' Scheduling is set to "Show Location Criteria", then this flag cannot be set to 'true' because it will trigger either error	false
LocationCriteriaClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', location criteria for unnamed candidate is cleared and location criteria (LocationIdentities) defined in PwsProjectRoleDetail is ignored; If set to 'false', location criteria (LocationIdentities) will be updated if provided in PwsProjectRoleDetail.	false
Mode	String (1)	On Insert: Yes On Update: Yes		A: booked data for roles R: requested data for roles	A
ProjectIdentity	PwsProjectRef	On Insert: Yes On Update: Yes		The identity of the project that contains the project role(s). Click here for more information.
ProjectRole	PwsProjectRoleDetail	On Insert: Yes On Update: Yes		Structure that contains the complete information of the project role. Please click here for more information.. If it refers to an existing project role, this request updates this project role; otherwise, this request creates a new project role.
ResourceClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing named resource is cleared. Named resource (resourceIdentity) in PwsProjectRoleDetail must be undefined*; If set to 'false', named resource (resourceIdentity) will be updated if provided in PwsProjectRoleDetail.	false
RoleEndDateClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing role end date is cleared. Role end date in PwsProjectRoleDetail must be undefined*; If set to 'false', existing role end date will be updated if provided in PwsProjectRoleDetail.	false
RoleStartDateClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', existing role start date is cleared. Role end date in PwsProjectRoleDetail must be undefined*; If set to 'false', existing role start date will be updated if provided in PwsProjectRoleDetail.	false
ShareCostCenterClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', role's shared cost center is cleared. Shared cost center (shareCostCenterIdentity) in PwsProjectRoleDetail must be undefined*; If set to 'false', Shared cost center (shareCostCenterIdentity) will be updated if provided in PwsProjectRoleDetail.	false
SkillCriteriaClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', skill criteria for unnamed candidate is cleared and skill criteria defined in PwsProjectRoleDetail is ignored; If set to 'false', skill criteria will be updated if provided in PwsProjectRoleDetail.	false
StealLockFlag	Boolean	No	false	True to steal lock if it is currently locked (otherwise, service will fail if engagement is locked)	false
TitleClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', preferred title for unnamed candidate is cleared. Preferred title (TitleIdentity) in PwsProjectRoleDetail must be undefined*; If set to 'false', preferred title (TitleIdentity)will be updated if provided in PwsProjectRoleDetail.	false
TitleCriteriaClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', title criteria for unnamed candidate is cleared and title criteria (TitleIdentities) defined in PwsProjectRoleDetail is ignored; If set to 'false', title criteria (TitleIdentities) will be updated if provided in PwsProjectRoleDetail.	false
RdcTransferHourlyRateClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', RDC transfer hourly rate is cleared and RdcTransferHourlyRate defined in PwsProjectRoleDetail is ignored; If set to 'false', RdcTransferHourlyRate will be updated if provided in PwsProjectRoleDetail.	false
RevenueTransferHourlyRateClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', revenue transfer hourly rate is cleared and RevenueTransferHourlyRate defined in PwsProjectRoleDetail is ignored; If set to 'false', RevenueTransferHourlyRate will be updated if provided in PwsProjectRoleDetail.	false
RateExceptionsClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', overriding rate is cleared and RateExceptions defined in PwsProjectRoleDetail is ignored; If set to 'false', RateExceptions will be updated if provided in PwsProjectRoleDetail.	false
RdcExceptionsClearFlag	Boolean	On Insert: No On Update: No	false	If set to 'true', overriding RDC rate is cleared and RdcExceptions defined in PwsProjectRoleDetail is ignored; If set to 'false', RdcExceptions will be updated if provided in PwsProjectRoleDetail.	false

Request Usage Example(s)

Example 01 - create/update

<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/" xmlns:com1="http://projectorpsa.com/CommonServices/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveProjectRole>
         <pws:serviceRequest>
            <req:SessionTicket>Ae9v30fDNwFMx833f5Hesg==</req:SessionTicket>
            <sch:CandidatesClearFlag>true</sch:CandidatesClearFlag>
            <sch:CostCenterCriteriaClearFlag>true</sch:CostCenterCriteriaClearFlag>
            <sch:LocationCriteriaClearFlag>true</sch:LocationCriteriaClearFlag>
            <sch:Mode>A</sch:Mode>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001053-WS2</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:ProjectRole>
               <com:ExternalSystemIdentifier>Role 001</com:ExternalSystemIdentifier>
               <com:BaseRateOnTitleIdentity>
                  <com:DepartmentIdentity>
                     <com:DepartmentName>Management</com:DepartmentName>
                  </com:DepartmentIdentity>
                  <com:TitleName>Administrator</com:TitleName>
               </com:BaseRateOnTitleIdentity>
               <com:CandidateIdentities>
                  <com:PwsResourceRef>
                     <com:ResourceDisplayName>Max Yang</com:ResourceDisplayName>
                  </com:PwsResourceRef>
               </com:CandidateIdentities>
               <com:CostCenterAnyFlag>false</com:CostCenterAnyFlag>
               <com:CostCenterCriteria>
                  <com1:PwsCostCenterCriteria>
                     <com1:CascadeFlag>true</com1:CascadeFlag>
                     <com1:CostCenterIdentity>
                        <com:CostCenterName>RevCorp CH</com:CostCenterName>
                     </com1:CostCenterIdentity>
                  </com1:PwsCostCenterCriteria>
               </com:CostCenterCriteria>
               <com:CostCenterIdentity>
                  <com:CostCenterName>RevCorp CA</com:CostCenterName>
               </com:CostCenterIdentity>
               <com:DefaultSchedulingMode>W</com:DefaultSchedulingMode>
               <com:Description>Created from PwsSaveProjectRole #2</com:Description>
               <com:Keywords>Executive</com:Keywords>
               <com:LocationAnyFlag>true</com:LocationAnyFlag>
               <com:LocationIdentities>
                  <com:PwsLocationRef>
                     <com:LocationName>Boston</com:LocationName>
                  </com:PwsLocationRef>
               </com:LocationIdentities>
               <com:LocationIdentity>
                  <com:LocationName>Shanghai</com:LocationName>
               </com:LocationIdentity>
               <com:ResourceIdentity>
                  <com:ResourceDisplayName>Oscar Cox</com:ResourceDisplayName>
               </com:ResourceIdentity>
               <com:RoleName>Role WS-001</com:RoleName>
               <com:RoleStartDate>2018-01-01z</com:RoleStartDate>
               <com:ShareCostCenterIdentity>
               </com:ShareCostCenterIdentity>
               <com:SkillCriteria>
                  <com:PwsSkillCriteria>
                     <com:SkillIdentity>
                        <com:SkillGroupIdentity>
                           <com:SkillGroupName>Technology</com:SkillGroupName>
                        </com:SkillGroupIdentity>
                        <com:SkillName>HTML</com:SkillName>
                     </com:SkillIdentity>
                     <com:SkillLevelMask>3</com:SkillLevelMask>
                  </com:PwsSkillCriteria>
               </com:SkillCriteria>
               <com:TitleIdentities>
                  <com:PwsTitleRef>
                     <com:DepartmentIdentity>
                        <com:DepartmentName>Technology</com:DepartmentName>
                     </com:DepartmentIdentity>
                     <com:TitleName>Technical Consultant</com:TitleName>
                  </com:PwsTitleRef>
               </com:TitleIdentities>
               <com:TitleIdentity>
                  <com:DepartmentIdentity>
                     <com:DepartmentName>Technology</com:DepartmentName>
                  </com:DepartmentIdentity>
                  <com:TitleName>Technical Consultant</com:TitleName>
               </com:TitleIdentity>
               <com:RdcTransferCurrencyIdentity>
               </com:RdcTransferCurrencyIdentity>
               <com:RevenueTransferHourlyRate>12</com:RevenueTransferHourlyRate>
            </sch:ProjectRole>
            <sch:ShareCostCenterClearFlag>true</sch:ShareCostCenterClearFlag>
            <sch:SkillCriteriaClearFlag>true</sch:SkillCriteriaClearFlag>
            <sch:StealLockFlag>true</sch:StealLockFlag>
            <sch:TitleCriteriaClearFlag>true</sch:TitleCriteriaClearFlag>
            <sch:RdcTransferHourlyRateClearFlag>false</sch:RdcTransferHourlyRateClearFlag>
            <sch:RevenueTransferHourlyRateClearFlag>true</sch:RevenueTransferHourlyRateClearFlag>
         </pws:serviceRequest>
      </pws:PwsSaveProjectRole>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSaveProjectRole Response

PwsSaveProjectRoleResponse
- PwsSaveProjectRoleResult: PwsSaveProjectRoleRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ProjectRoleIdentity: PwsProjectRoleRef
  - EngagementTimestamp: String
  - LockStolenFromUserIdentity: PwsUserRef

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage	The web service response status and message. Click here for 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-02-14T15:34:53.8497124Z
ProjectRoleIdentity	PwsProjectRoleRef	The identity of the project role just created/updated. Click here for more information.
EngagementTimestamp	String	This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveEngagement(or a prior call to PwsSaveEngagement). This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsSaveEngagement.	AAAAAA+d7G0=
LockStolenFromUserIdentity	PwsUserRef	The identity of the user from whom the engagement lock is stolen from. Click here for more information.

Response Usage Example(s)

Example 01 - create/update

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveProjectRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveProjectRoleResult 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/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-14T15:34:53.8497124Z</ServerTimestampUtc>
            <a:ProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ExternalSystemIdentifier i:nil="true"/>
               <b:ProjectRoleId i:nil="true"/>
               <b:ProjectRoleUid>1152921504609589510</b:ProjectRoleUid>
            </a:ProjectRoleIdentity>
            <a:EngagementTimestamp>AAAAAA+d7G0=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsSaveProjectRoleResult>
      </PwsSaveProjectRoleResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
14009	RoleResourceMayNotBeSpecifiedWhenClearFlagSet	Resource may not be specified when resouce clear flag is set.
14010	RoleCostCenterMayNotBeSpecifiedWhenClearFlagSet	Cost center may not be specified when cost center clear flag is set.
14011	RoleLocationMayNotBeSpecifiedWhenClearFlagSet	Location may not be specified when location clear flag is set.
14012	RoleTitleMayNotBeSpecifiedWhenClearFlagSet	Title may not be specified when title clear flag is set.
14013	RoleKeywordsMayNotBeSpecifiedWhenClearFlagSet	Keywords may not be specified when keywords clear flag is set.
14014	ShareCostCenterMayNotBeSpecifiedWhenClearFlagSet	Share cost center may not be specified when share cost center clear flag is set.
14015	BaseRatesOnTitleMayNotBeSpecifiedWhenClearFlagSet	Base rates on title may not be specified when base rates on title clear flag is set.
14016	RoleStartDateMayNotBeSpecifiedWhenClearFlagSet	Role start date may not be specified when role start date clear flag is set.
14017	RoleEndDateMayNotBeSpecifiedWhenClearFlagSet	Role end date may not be specified when role end date clear flag is set.
14018	RoleDescriptionMayNotBeSpecifiedWhenClearFlagSet	Role description may not be set when role description clear flag is set.
14025	RdcTransferRateIncomplete	RDC transfer hourly rate specified without RDC transfer currency, or vice versa.
54199	RdcTransferDataIncomplete	RDC transfer hourly rate specified without RDC transfer currency, or vice versa.
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).
54738	ShareCostCenterInactive	The specified share cost center is inactive.
54741	RoleNameNotSpecified	Role name is required for new roles.
54743	RoleNameAlreadyInUse	Specified role name is already in use.
54776	MissingPreferredAllocatedCostCenter	Missing preferred or allocated cost center.
54777	MissingPreferredAllocatedLocation	Missing preferred or allocated location.
54875	MissingValueForCostCenterOrLocationAnyFlags	Cost center and location any flags are required for new roles.
57535	TitleNotFound	The specified title does not exist.