Versions Compared

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 (rates will be based on resource's title).

false

CandidatesClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing named candidates will be cleared (candidate identities defined inPwsProjectRoleDetail are ignored).

false

CostCenterClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', preferred cost center for unnamed candidate is cleared (preferred cost center identity defined in PwsProjectRoleDetail is ignored).

false

CostCenterCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', cost center criteria for unnamed candidate is cleared (cost center criteria defined in PwsProjectRoleDetail is ignored).

false

DescriptionClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', the existing description will be cleared.

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 PwsGetProject or a prior call to PwsSaveProjectRole. This will cause the request to fail if any change has been made between invocations of PwsGetProject and PwsSaveProjectRole.


KeywordsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing keywords for unnamed candidate is cleared.

false

LocationClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', preferred location for unnamed candidate is cleared. Please note, if System Settings' Scheduling is set to "Show Location Criteria", then this flag cannot be set to 'true' because location criteria is required.

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


Determine whether specified criteria applies to booked or requested criteria settings.

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

false

RoleEndDateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing role end date is cleared.

false

RoleStartDateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', existing role start date is cleared.

false

ShareCostCenterClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', role's shared cost center is cleared.

false

SkillCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', skill criteria for unnamed candidate is cleared (skill criteria defined in PwsProjectRoleDetail is ignored).

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.

false

TitleCriteriaClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', title criteria for unnamed candidate is cleared (title criteria (TitleIdentities) defined in PwsProjectRoleDetail is ignored).

false

RdcTransferHourlyRateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', RDC transfer hourly rate is cleared (RdcTransferHourlyRate defined in PwsProjectRoleDetail is ignored).

false

RevenueTransferHourlyRateClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', revenue transfer hourly rate is cleared (RevenueTransferHourlyRate defined in PwsProjectRoleDetail is ignored).

false

RateExceptionsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', overriding rate is cleared (RateExceptions defined in PwsProjectRoleDetail is ignored).

false

RdcExceptionsClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', overriding RDC rate is cleared (RdcExceptions defined in PwsProjectRoleDetail is ignored).

false

WarnOnPermissionErrorFlagBoolean

On Insert: No

On Update: No

false

If set to 'true', request will result in warnings instead of errors if user has no permission (on insert only):

- Attempt to set sharing (by user or cost center) without permission to share scheduling.
- Attempt to set billing title override without permission to maintain rates
- Attempt to set revenue transfer hourly rate without permission to maintain rates
- Attempt to set RDC transfer hourly rate without permission to maintain rates
- Attempt to set rate or RDC exceptions without permission to maintain rates

false


Request Usage Example(s)


Code Block
languagexml
titleExample 0201 - 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>Af6PogAbIuL3jTtirBShRgSessionTicket>Ae9v30fDNwFMx833f5Hesg==</req:SessionTicket>
            <sch:Mode>R<CandidatesClearFlag>true</sch:Mode>CandidatesClearFlag>
            <sch:CostCenterCriteriaClearFlag>true</sch:ProjectIdentity>CostCenterCriteriaClearFlag>
               <com:ProjectCode>P001508-001</com:ProjectCode><sch:LocationCriteriaClearFlag>true</sch:LocationCriteriaClearFlag>
            <<sch:Mode>A</sch:ProjectIdentity>Mode>
            <sch:ProjectRole>ProjectIdentity>
               <com:BaseRateOnTitleIdentity>:ProjectCode>P001053-WS2</com:ProjectCode>
            </sch:ProjectIdentity>
      <com:DepartmentIdentity>      <sch:ProjectRole>
               <com:DepartmentName>ITExternalSystemIdentifier>Role Team<001</com:DepartmentName>ExternalSystemIdentifier>
               <com:BaseRateOnTitleIdentity>
  </com                <com:DepartmentIdentity>
                     <com:TitleName>Level 1<DepartmentName>Management</com:TitleName>DepartmentName>
                  </com:BaseRateOnTitleIdentity>DepartmentIdentity>
                  <com:CostCenterAnyFlag>false<TitleName>Administrator</com:CostCenterAnyFlag>TitleName>
               <com</com:CostCenterCriteria>BaseRateOnTitleIdentity>
               <com:CandidateIdentities>
  <com1:PwsCostCenterCriteria>                <com:PwsResourceRef>
     <com1:CascadeFlag>false</com1:CascadeFlag>                <com:ResourceDisplayName>Max Yang</com:ResourceDisplayName>
    <com1:CostCenterIdentity>              </com:PwsResourceRef>
          <com:CostCenterName>IT Team (USA)    </com:CostCenterName>CandidateIdentities>
                     </com1:CostCenterIdentity><com:CostCenterAnyFlag>false</com:CostCenterAnyFlag>
               <com:CostCenterCriteria>
  </com1:PwsCostCenterCriteria>                </com<com1:CostCenterCriteria>PwsCostCenterCriteria>
               <com:CostCenterIdentity>      <com1:CascadeFlag>true</com1:CascadeFlag>
            <com:CostCenterNumber>IT Team (USA)</com:CostCenterNumber>       <com1:CostCenterIdentity>
        </com:CostCenterIdentity>                <com:LocationAnyFlag>false<CostCenterName>RevCorp CH</com:LocationAnyFlag>CostCenterName>
               <com:LocationIdentities>        </com1:CostCenterIdentity>
                  <com:PwsLocationRef></com1:PwsCostCenterCriteria>
               </com:CostCenterCriteria>
               <com:LocationName>USA</com:LocationName>CostCenterIdentity>
                  <<com:CostCenterName>RevCorp CA</com:PwsLocationRef>CostCenterName>
               </com:LocationIdentities>CostCenterIdentity>
               <com:DefaultSchedulingMode>W</com:LocationIdentity>DefaultSchedulingMode>
               <com:Description>Created from PwsSaveProjectRole <com:LocationName>USA<#2</com:LocationName>Description>
               <<com:Keywords>Executive</com:LocationIdentity>Keywords>
               <com:RoleName>Consultant<LocationAnyFlag>true</com:RoleName>LocationAnyFlag>
               <com:TitleIdentities>LocationIdentities>
                  <com:PwsTitleRef>PwsLocationRef>
                     <com:DepartmentIdentity>LocationName>Boston</com:LocationName>
                        <com:DepartmentName>IT Team<</com:DepartmentName>
     PwsLocationRef>
               </com:DepartmentIdentity>
  LocationIdentities>
                  <com:TitleName>LevelLocationIdentity>
1</com:TitleName>                   <<com:LocationName>Shanghai</com:PwsTitleRef>LocationName>
               </com:TitleIdentities>LocationIdentity>
               <com:TitleIdentity>ResourceIdentity>
                  <com:DepartmentIdentity>ResourceDisplayName>Oscar Cox</com:ResourceDisplayName>
                    <com:DepartmentName>IT Team<</com:DepartmentName>ResourceIdentity>
                  <<com:RoleName>Role WS-001</com:DepartmentIdentity>RoleName>
               <com:RoleStartDate>2018-01-01z</com:RoleStartDate>
               <com:TitleName>Level 1</com:TitleName>ShareCostCenterIdentity>
               </com:TitleIdentity>ShareCostCenterIdentity>
               <com:ResourceTypeAnyFlag>true</com:ResourceTypeAnyFlag>SkillCriteria>
                  </sch:ProjectRole><com:PwsSkillCriteria>
          </pws:serviceRequest>       </pws:PwsSaveProjectRole>    </soapenv:Body>
</soapenv:Envelope>

Request Usage Example(s)

Code Block
languagexml
titleExample 01 - 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><com:SkillIdentity>
                 <pws:PwsSaveProjectRole>       <com:SkillGroupIdentity>
  <pws:serviceRequest>             <req:SessionTicket>Ae9v30fDNwFMx833f5Hesg==</req:SessionTicket>             <sch<com:CandidatesClearFlag>true<SkillGroupName>Technology</schcom:CandidatesClearFlag>SkillGroupName>
            <sch:CostCenterCriteriaClearFlag>true</sch:CostCenterCriteriaClearFlag>             <sch:LocationCriteriaClearFlag>true<</sch:LocationCriteriaClearFlag>com:SkillGroupIdentity>
                    <sch:Mode>A</sch:Mode>       <com:SkillName>HTML</com:SkillName>
     <sch:ProjectIdentity>                <com:ProjectCode>P001053-WS2<</com:ProjectCode>SkillIdentity>
            </sch:ProjectIdentity>           <com:SkillLevelMask>3</com:SkillLevelMask>
 <sch:ProjectRole>                <com:ExternalSystemIdentifier>Role 001<</com:ExternalSystemIdentifier>PwsSkillCriteria>
               <com</com:BaseRateOnTitleIdentity>SkillCriteria>
                  <com:DepartmentIdentity>TitleIdentities>
                  <com:PwsTitleRef>
  <com:DepartmentName>Management</com:DepartmentName>                   </com<com:DepartmentIdentity>
                        <com:TitleName>Administrator</com:TitleName>DepartmentName>Technology</com:DepartmentName>
                     </com:BaseRateOnTitleIdentity>DepartmentIdentity>
               <com:CandidateIdentities>      <com:TitleName>Technical Consultant</com:TitleName>
           <com:PwsResourceRef>       </com:PwsTitleRef>
              <com:ResourceDisplayName>Max Yang<</com:ResourceDisplayName>TitleIdentities>
               <com:TitleIdentity>
  </com:PwsResourceRef>                </com:CandidateIdentities><com:DepartmentIdentity>
                     <com:CostCenterAnyFlag>false<DepartmentName>Technology</com:CostCenterAnyFlag>DepartmentName>
               <com:CostCenterCriteria>   </com:DepartmentIdentity>
               <com1:PwsCostCenterCriteria>      <com:TitleName>Technical Consultant</com:TitleName>
               <com1:CascadeFlag>true<</com1com:CascadeFlag>TitleIdentity>
               <com:RdcTransferCurrencyIdentity>
      <com1:CostCenterIdentity>         </com:RdcTransferCurrencyIdentity>
               <com:CostCenterName>RevCorp CH<RevenueTransferHourlyRate>12</com:CostCenterName>RevenueTransferHourlyRate>
            </sch:ProjectRole>
            <<sch:ShareCostCenterClearFlag>true</com1:CostCenterIdentity>sch:ShareCostCenterClearFlag>
            <sch:SkillCriteriaClearFlag>true</sch:SkillCriteriaClearFlag>
            <<sch:StealLockFlag>true</com1sch:PwsCostCenterCriteria>StealLockFlag>
            <sch:TitleCriteriaClearFlag>true</sch:TitleCriteriaClearFlag>
  </com:CostCenterCriteria>          <sch:RdcTransferHourlyRateClearFlag>false</sch:RdcTransferHourlyRateClearFlag>
         <com:CostCenterIdentity>   <sch:RevenueTransferHourlyRateClearFlag>true</sch:RevenueTransferHourlyRateClearFlag>
         </pws:serviceRequest>
     <com:CostCenterName>RevCorp CA<</compws:CostCenterName>PwsSaveProjectRole>
   </soapenv:Body>
</soapenv:Envelope>
Code Block
languagexml
titleExample 02
collapsetrue
<soapenv:Envelope           </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>
       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>
       <com<pws:LocationIdentities>PwsSaveProjectRole>
                  <com:PwsLocationRef><pws:serviceRequest>
                     <com:LocationName>Boston</com:LocationName><req:SessionTicket>Af6PogAbIuL3jTtirBShRg==</req:SessionTicket>
                  </com:PwsLocationRef>
  <sch:Mode>R</sch:Mode>
            </com<sch:LocationIdentities>ProjectIdentity>
               <com:LocationIdentity>:ProjectCode>P001508-001</com:ProjectCode>
                  <com:LocationName>Shanghai</com:LocationName></sch:ProjectIdentity>
               </com:LocationIdentity><sch:ProjectRole>
               <com:ResourceIdentity>BaseRateOnTitleIdentity>
                  <com:ResourceDisplayName>Oscar Cox</com:ResourceDisplayName>DepartmentIdentity>
                     <com:DepartmentName>IT <Team</com:ResourceIdentity>DepartmentName>
                 <com:RoleName>Role WS-001< </com:RoleName>DepartmentIdentity>
                  <com:RoleStartDate>2018-01-01z<TitleName>Level 1</com:RoleStartDate>TitleName>
               <com</com:ShareCostCenterIdentity>BaseRateOnTitleIdentity>
               <<com:CostCenterAnyFlag>false</com:ShareCostCenterIdentity>CostCenterAnyFlag>
               <com:SkillCriteria>CostCenterCriteria>
                  <com<com1:PwsSkillCriteria>PwsCostCenterCriteria>
                     <com:SkillIdentity><com1:CascadeFlag>false</com1:CascadeFlag>
                        <com:SkillGroupIdentity><com1:CostCenterIdentity>
                        <com:CostCenterName>IT   <com:SkillGroupName>Technology<Team (USA)</com:SkillGroupName>CostCenterName>
                        </comcom1:SkillGroupIdentity>CostCenterIdentity>
                  </com1:PwsCostCenterCriteria>
     <com:SkillName>HTML</com:SkillName>          </com:CostCenterCriteria>
           </com:SkillIdentity>    <com:CostCenterIdentity>
                  <com:SkillLevelMask>3<CostCenterNumber>IT Team (USA)</com:SkillLevelMask>CostCenterNumber>
                  </com:PwsSkillCriteria>CostCenterIdentity>
               <<com:LocationAnyFlag>false</com:SkillCriteria>LocationAnyFlag>
               <com:TitleIdentities>LocationIdentities>
                  <com:PwsTitleRef>PwsLocationRef>
                     <com:DepartmentIdentity>:LocationName>USA</com:LocationName>
                  </com:PwsLocationRef>
               <com:DepartmentName>Technology<</com:DepartmentName>LocationIdentities>
               <com:LocationIdentity>
             </com:DepartmentIdentity>     <com:LocationName>USA</com:LocationName>
                <com:TitleName>Technical Consultant<</com:TitleName>LocationIdentity>
                  <<com:RoleName>Consultant</com:PwsTitleRef>RoleName>
               </com<com:TitleIdentities>
                  <com:TitleIdentity>PwsTitleRef>
                     <com:DepartmentIdentity>
                        <com:DepartmentName>Technology<DepartmentName>IT Team</com:DepartmentName>
                     </com:DepartmentIdentity>
                     <com:TitleName>TechnicalTitleName>Level Consultant<1</com:TitleName>
                  </com:TitleIdentity>PwsTitleRef>
               <com:RdcTransferCurrencyIdentity></com:TitleIdentities>
               <com:TitleIdentity>
          </com:RdcTransferCurrencyIdentity>        <com:DepartmentIdentity>
         <com:RevenueTransferHourlyRate>12</com:RevenueTransferHourlyRate>            <com:DepartmentName>IT <Team</schcom:ProjectRole>DepartmentName>
            <sch:ShareCostCenterClearFlag>true</sch:ShareCostCenterClearFlag>      </com:DepartmentIdentity>
      <sch:SkillCriteriaClearFlag>true</sch:SkillCriteriaClearFlag>             <sch:StealLockFlag>true</sch:StealLockFlag><com:TitleName>Level 1</com:TitleName>
               <sch:TitleCriteriaClearFlag>true<</sch:TitleCriteriaClearFlag>com:TitleIdentity>
               <sch<com:RdcTransferHourlyRateClearFlag>false<ResourceTypeAnyFlag>true</schcom:RdcTransferHourlyRateClearFlag>ResourceTypeAnyFlag>
            <sch:RevenueTransferHourlyRateClearFlag>true<</sch:RevenueTransferHourlyRateClearFlag>ProjectRole>
         </pws:serviceRequest>
      </pws:PwsSaveProjectRole>
   </soapenv:Body>
</soapenv:Envelope>

...