Versions Compared

Old Version 11

changes.mady.by.user Min Zeng

Saved on

compared with

New Version Current

changes.mady.by.user Bettina Borces

Saved on

Key

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

Overview


Info
We recommend using the newer version of this request PwsSaveProjectTaskTypes. 

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

Request Format

Panel
titlePwsSaveProjectTaskType Request

Request Elements

...

Element

...

Data Type

...

Required?

...

Default

...

Description

...

Sample Data

...

RequestId

...

Int32

...

No

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.


SessionTicketProjectTaskType

StringPwsProjectTaskTypeDetail

Yes


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


AllowedProjectRateTypesClearFlagStealLockFlag

Boolean

No

false

If set to 'true', non-default allowed project rate types are cleared. Allowed project rate type supplied in PwsProjectTaskTypeDetail is 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 a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information.

false**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>

...

Panel
titlePwsSaveProjectTaskType Response

Response Elements


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 if any change has been made between the two invocations.If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information

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 Click here for  for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-01T17:44:55.4574017Z

ProjectTaskTypeIdentity

PwsProjectTaskTypeRef

The identity of the project task type that was just saved. Click here for more information.EngagementTimestampClick here for more information.


EngagementTimestamp

String

**deprecated**


LockStolenFromUserIdentity

PwsUserRef

**deprecated**


RateTaskTimestampStringThis is an optimistic locking timestamp that, if provided on update request, will cause the request to fail 
AAAAAA+xjsY=

LockStolenFromUserIdentity

PwsUserRef

when the timestamp stored in the database does not match the provided value.
StolenLocksPwsEntityLockSummaryThis structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request.

Response Usage Example(s)

...

Code Block
languagexml
titleExample 02
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveProjectTaskTypeResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveProjectTaskTypeResult 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-03-01T19:20:00.629574Z</ServerTimestampUtc>
            <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ExternalSystemIdentifier i:nil="true"/>
               <b:ProjectTaskTypeId i:nil="true"/>
               <b:ProjectTaskTypeUid>1152921504608111799</b:ProjectTaskTypeUid>
            </a:ProjectTaskTypeIdentity>
            <a:EngagementTimestamp>AAAAAA+ydcs=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
               <b:UserUid>1152921504606944261</b:UserUid>
            </a:LockStolenFromUserIdentity>
         </PwsSaveProjectTaskTypeResult>
      </PwsSaveProjectTaskTypeResponse>
   </s:Body>
</s:Envelope>

PwsSaveProjectTaskType - Common Errors and Warnings

ErrorNumberErrorCodeErrorText
15002ProjectNotSpecifiedForSaveTaskTypeNo project was specified for saving project task type.
54645ProjectTaskTypeNameIsRequiredThe project task type name is required for new project task types.
54646ProjectTaskTypeNameAlreadyInUseThe specified project task type name is already in use.
54647ProjectRateTypeIsRequiredThe default project rate type is required for new project task types.
54650ProjectRateTypeNotFoundThe specified default project rate type does not exist.
55069TaskTypePurchaseOrderSpecifiedWhenInheritingPurchase order number may not be specified when inheriting purchase order number.
57556TaskTypeNotSpecifiedThe standard task type is required for new project task types.