/
PwsTransferTime

PwsTransferTime

Overview


This web service transfers one or more time cards to another project and/or rate and/or role and/or project task.


Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


PwsTransferTime

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestIdInt32No
Click here for more information
1
SessionTicket

String

Yes
Click here for more information
AWuKIeUvHQC5lNzuzE3Ugg==
AdjustRoleDatesAsNeededFlagBooleanNofalseIf set to true, the start and/or end date on any associated roles will be adjusted to accommodate the work date on the time card(s)
true
AdjustmentCodeIdentityPwsAdjustmentCodeRefNo
This structure represents the unique key fields associated with identifying an adjustment code. Adjustment codes are required whenever you make a monetary adjustment to a time or cost card.  This is not applicable to this service.
AdjustmentTypeStringYes

The type of time transfer adjustment to be applied. This must be one of the following values:

'TPT' for Transfer Time to Role

'TRT' for Transfer and Exclude Time

'CTT' for Change Task/Task Code


Explanation

String (1024)

No
An explanation as to why this adjustment was applied.
Transferring time to the active project
ReportOnlyFlagBooleanNo
If set to "true", the time card importing process is exercised, but not completed. If there is any error triggered during the importing process, it will be reported in the response.
false
TransferOrdersPwsTimeTransferOrder
Yes
This structure represents the time cards that will be transferred

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:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsTransferTime>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWuKIeUvHQC5lNzuzE3Ugg==</req:SessionTicket>
            <tim:AdjustProjectRoleDatesAsNeededFlag>true</tim:AdjustProjectRoleDatesAsNeededFlag>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
               <com:AdjustmentCodeUid>1152921504606858479</com:AdjustmentCodeUid>
            </tim:AdjustmentCodeIdentity>
            <tim:AdjustmentType>TPT</tim:AdjustmentType>
            <tim:Explanation>Transferring time to the active project</tim:Explanation>
            <tim:ReportOnlyFlag>false</tim:ReportOnlyFlag>
            <tim:TransferOrders>
               <tim:PwsTimeTransferOrder>
                  <tim:NewProjectIdentity>
                     <com:ProjectCode>P001556-001</com:ProjectCode>
                     <com:ProjectId>603784</com:ProjectId>
                     <com:ProjectUid>1152921504607450760</com:ProjectUid>
                  </tim:NewProjectIdentity>
                  <tim:NewProjectRateTypeIdentity>
                     <!--com:ExternalSystemIdentifier>?</com:ExternalSystemIdentifier-->
                     <com:ProjectRateTypeId>563091</com:ProjectRateTypeId>
                     <com:ProjectRateTypeUid>1152921504607410067</com:ProjectRateTypeUid>
                  </tim:NewProjectRateTypeIdentity>
                  <tim:NewProjectRoleIdentity>
                     <com:ExternalSystemIdentifier>?</com:ExternalSystemIdentifier>
                     <com:ProjectRoleId>2954826</com:ProjectRoleId>
                     <com:ProjectRoleUid>1152921504609801802</com:ProjectRoleUid>
                  </tim:NewProjectRoleIdentity>
                  <tim:NewProjectRoleName>Developer</tim:NewProjectRoleName>
                  <tim:NewProjectTaskIdentity>
                     <!--com:ExternalSystemIdentifier>?</com:ExternalSystemIdentifier-->
                     <com:ProjectTaskId>2093964</com:ProjectTaskId>
                     <com:ProjectTaskUid>1152921504608940940</com:ProjectTaskUid>
                  </tim:NewProjectTaskIdentity>
                  <tim:TimeCardIdentities>
                     <tim:PwsVersionedTimecardRef>
                        <!--com:ReferenceId>?</com:ReferenceId-->
                        <com:TimecardId>45639611</com:TimecardId>
                        <com:TimecardType>T</com:TimecardType>
                        <com:TimecardUid>1152921504652486587</com:TimecardUid>
                        <!--tim:Timestamp>?</tim:Timestamp-->
                     </tim:PwsVersionedTimecardRef>
                  </tim:TimeCardIdentities>
               </tim:PwsTimeTransferOrder>
            </tim:TransferOrders>
         </pws:serviceRequest>
      </pws:PwsTransferTime>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsTransferTime Response

Response Elements


Element

Data Type

Description

Sample Data

MessagesPwsMessage[]

The web service response status and message. Click here for more information.


ResponseIdInt32Click here for more information
1
StatusRequestStatusClick here for more information
Ok
ServerTimestampUtcDateTimeClick here for more information
2019-11-07T22:24:06.8248708Z
TimeCardIdentitiesPwsTimeCardRefThe identities of the time cards that were updated.

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsTransferTimeResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsTransferTimeResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" 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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2019-11-07T22:24:06.8248708Z</ServerTimestampUtc>
            <a:TimeCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTimecardRef>
                  <b:ReferenceId i:nil="true"/>
                  <b:TimecardId>45639611</b:TimecardId>
                  <b:TimecardType>T</b:TimecardType>
                  <b:TimecardUid>1152921504652486587</b:TimecardUid>
               </b:PwsTimecardRef>
            </a:TimeCardIdentities>
            <a:TimecardValuationReport/>
         </PwsTransferTimeResult>
      </PwsTransferTimeResponse>
   </s:Body>
</s:Envelope>

PwsTransferTime - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

20066InvalidValueForTimeAdjustmentTypePlease specify either TPT, TRT or CTT for the time card transfer adjustment type.
50024EntityNotFoundTime Card was not found. Another user may have deleted it.
64365OneOrMoreTimeCardsIneligibleForAdjustment

Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment.



Related content

PwsTransferCost
PwsTransferCost
More like this
PwsRevalueTime
PwsRevalueTime
More like this
PwsAdjustTimeDescription
PwsAdjustTimeDescription
More like this
PwsTransferOverageHours
PwsTransferOverageHours
More like this
PwsSplitTimeCards
PwsSplitTimeCards
More like this
PwsWriteUpDownTime
PwsWriteUpDownTime
More like this