Overview

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

Request Format

PwsSaveProjectTaskType Request

PwsSaveProjectTaskType
- serviceRequest: PwsSaveProjectTaskTypeRq
  - RequestId: Int32
  - SessionTicket: String
  - AllowedProjectRateTypesClearFlag: Boolean
  - EngagementTimestamp: String
  - ProjectIdentity: PwsProjectRef
  - ProjectTaskType: PwsProjectTaskTypeDetail
  - StealLockFlag: 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.
AllowedProjectRateTypesClearFlag	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

Request Usage Example(s)

Example 01

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

Example 02

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/"

Response Format

PwsSaveProjectTaskType Response

PwsSaveProjectTaskTypeResponse
- PwsSaveProjectTaskTypeResult: PwsSaveProjectTaskTypeRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ProjectTaskTypeIdentity: PwsProjectTaskTypeRef
  - 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-03-01T17:44:55.4574017Z
ProjectTaskTypeIdentity	PwsProjectTaskTypeRef	The identity of the project task type that was just saved. 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 in a prior response. This will cause the request to fail if any change has been made between the two invocations.	AAAAAA+xjsY=
LockStolenFromUserIdentity	PwsUserRef	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.

Response Usage Example(s)

Example 01

<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-01T18:56:35.3531998Z</ServerTimestampUtc>
            <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ExternalSystemIdentifier i:nil="true"/>
               <b:ProjectTaskTypeId i:nil="true"/>
               <b:ProjectTaskTypeUid>1152921504608111785</b:ProjectTaskTypeUid>
            </a:ProjectTaskTypeIdentity>
            <a:EngagementTimestamp>AAAAAA+ya7o=</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>

Example 02

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
15002	ProjectNotSpecifiedForSaveTaskType	No project was specified for saving project task type.
54646	ProjectTaskTypeNameAlreadyInUse	The specified project task type name is already in use.
54650	ProjectRateTypeNotFound	The specified default project rate type does not exist.
55069	TaskTypePurchaseOrderSpecifiedWhenInheriting	Purchase order number may not be specified when inheriting purchase order number.