Versions Compared

Version Old Version 35 New Version 36
Changes made by

Min Zeng

Min Zeng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 inPwsProjectRoleDetail 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

false

StealLockFlag

Boolean

No

false

True to steal lock if it is currently locked (otherwise, service will fail if engagement is locked) 

false

TitleClearFlagIf 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', preferred title for unnamed candidate is cleared. Preferred title (TitleIdentity) in PwsProjectRoleDetail must be undefined*overriding rate is cleared and RateExceptions defined in PwsProjectRoleDetail is ignored; If set to 'false', preferred title (TitleIdentity) RateExceptions will be updated if provided in PwsProjectRoleDetail.

false

TitleCriteriaClearFlagRdcExceptionsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', title criteria for unnamed candidate overriding RDC rate is cleared and title criteria (TitleIdentities) RdcExceptions defined in PwsProjectRoleDetail is ignored; If set to 'false', title criteria (TitleIdentities) RdcExceptions will be updated if provided in PwsProjectRoleDetail.

false

RdcTransferHourlyRateClearFlag

Boolean

RevenueTransferHourlyRateClearFlag

Boolean

RateExceptionsClearFlag

Boolean

RdcExceptionsClearFlag

Boolean

Request Usage Example(s)

Code Block
languagexml
titleExample 01 - simple create/update
collapsetrue
<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>

...

ErrorNumberErrorCodeErrorText
14009RoleResourceMayNotBeSpecifiedWhenClearFlagSetResource may not be specified when resouce clear flag is set.
14010RoleCostCenterMayNotBeSpecifiedWhenClearFlagSetCost center may not be specified when cost center clear flag is set.
14011RoleLocationMayNotBeSpecifiedWhenClearFlagSetLocation may not be specified when location clear flag is set.
14012RoleTitleMayNotBeSpecifiedWhenClearFlagSetTitle may not be specified when title clear flag is set.
14013RoleKeywordsMayNotBeSpecifiedWhenClearFlagSetKeywords may not be specified when keywords clear flag is set.
14014ShareCostCenterMayNotBeSpecifiedWhenClearFlagSetShare cost center may not be specified when share cost center clear flag is set.
14015BaseRatesOnTitleMayNotBeSpecifiedWhenClearFlagSetBase rates on title may not be specified when base rates on title clear flag is set.
14016RoleStartDateMayNotBeSpecifiedWhenClearFlagSetRole start date may not be specified when role start date clear flag is set.
14017RoleEndDateMayNotBeSpecifiedWhenClearFlagSetRole end date may not be specified when role end date clear flag is set.
14018RoleDescriptionMayNotBeSpecifiedWhenClearFlagSetRole description may not be set when role description clear flag is set.
14025RdcTransferRateIncompleteRDC transfer hourly rate specified without RDC transfer currency, or vice versa.
54199RdcTransferDataIncompleteRDC transfer hourly rate specified without and RDC transfer currency, or vice versa.
54583InvalidValueForModeThe value specified for mode is invalid. Valid values are R for Request, A for Allocate and E for Effective (for retrieval operations only).
54741RoleNameNotSpecifiedRole name is required for new roles.
54743RoleNameAlreadyInUseSpecified role name is already in use.
54776MissingPreferredAllocatedCostCenterMissing preferred or allocated cost center.
54777MissingPreferredAllocatedLocationMissing preferred or allocated location.
54875MissingValueForCostCenterOrLocationAnyFlagsCost center and location any flags are required for new roles.
57535TitleNotFoundThe specified title does not exist.

...