Versions Compared

Key

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

Overview


This web service inserts or updates a single project task type based on a detailed project task type structure (PwsProjectTaskTypeDetail). The service returns the identity (PwsProjectTaskTypeRef) of the project Task role that has been inserted or updated. 

Request Format

Panel
titlePwsSaveProjectTaskType Request

Request Elements

...

Element

...

Data Type

...

Required?

...

Default

...

Description

...

Sample Data

...

RequestId

...

Int32

...

No

structure (PwsProjectTaskTypeDetail). The service returns the identity (PwsProjectTaskTypeRef) of the project Task role that has been inserted or updated. 

Request Format


Panel
titlePwsSaveProjectTaskType Request

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.


AllowedProjectRateTypesClearFlag

Boolean

No

false

If set to 'true', non-default allowed project rate types are cleared. Allowed project rate types supplied in PwsProjectTaskTypeDetail are ignored.

true

EngagementTimestamp

String

**deprecated**




ProjectIdentity

PwsProjectRef

Yes


The identity of the project for the project task type. Click here for more information.


ProjectTaskType

PwsProjectTaskTypeDetail

Yes


The complete set of information for project task type. Click here for more information.


StealLockFlag

SessionTicket

String

Yes

Click here for more information.

AllowedProjectRateTypesClearFlag

Boolean

No

false

If set to 'true', non-default allowed project rate types are cleared. Allowed project rate types supplied in PwsProjectTaskTypeDetail are ignored.

true

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 in a prior response. This will cause the request to fail if any change has been made between the two invocations.

ProjectIdentity

PwsProjectRef

Yes

The identity of the project for the project task type. Click here for more information.

ProjectTaskType

PwsProjectTaskTypeDetail

Yes

The complete set of information for project task type. Click here for more information.

StealLockFlag

Boolean

No

false

If 'true', an existing engagement lock, if it exists, will be stolen and the operation will be allowed to proceed.

falseBoolean

**deprecated**




LocksToStealPwsEntityLockSummary[1.100]No
The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks.
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unit.
RateTaskTimestampStringNo
This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value.

Request Usage Example(s)


Code Block
languagexml
titleExample 01
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/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveProjectTaskType>
         <pws:serviceRequest>
            <req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==</req:SessionTicket>
            <sch:AllowedProjectRateTypesClearFlag>false</sch:AllowedProjectRateTypesClearFlag>
            <sch:ProjectIdentity>
               <com:ProjectCode>P001053-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:ProjectTaskType>
               <com:ProjectTaskTypeName>WS-Created</com:ProjectTaskTypeName>
               <com:AllowedProjectRateTypeIdentities>
                  <com:PwsProjectRateTypeRef>
                     <com:ProjectRateTypeUid>1152921504607351596</com:ProjectRateTypeUid>
                  </com:PwsProjectRateTypeRef>
               </com:AllowedProjectRateTypeIdentities>
               <com:DefaultProjectRateTypeIdentity>
                     <com:ProjectRateTypeUid>1152921504607351596</com:ProjectRateTypeUid>
               </com:DefaultProjectRateTypeIdentity>
               <com:InactiveFlag>false</com:InactiveFlag>
               <com:NarrativeRequiredFlag>true</com:NarrativeRequiredFlag>
               <com:SortOrder>1</com:SortOrder>
               <com:StandardTaskTypeIdentity>
                  <com:StandardTaskTypeName>Design</com:StandardTaskTypeName>
               </com:StandardTaskTypeIdentity>
               <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
               <com:PurchaseOrderNumber>PO:WS-001</com:PurchaseOrderNumber>
            </sch:ProjectTaskType>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsSaveProjectTaskType>
   </soapenv:Body>
</soapenv:Envelope>

...