/
PwsWriteUpDownTime

PwsWriteUpDownTime

Overview


This web service modifies the client amount on a time card by writing it up or down.


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


PwsWriteUpDownTime Request

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

String (1024)

No
An explanation as to why this adjustment was applied.
Writing up time card as per client conversation
WriteUpDownOrders
PwsTimeWriteUpDownOrderYes
This structure represents the key elements associated with a time card write up/down adjustment

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:PwsWriteUpDownTime>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWuKIeUvHQC5lNzuzE3Ugg==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeId>11503</com:AdjustmentCodeId>
               <com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
               <com:AdjustmentCodeUid>1152921504606858479</com:AdjustmentCodeUid>
            </tim:AdjustmentCodeIdentity>
            <tim:Explanation>Writing up time card as per client conversation</tim:Explanation>
            <tim:WriteUpDownOrders>
               <tim:PwsTimeWriteUpDownOrder>
                  <tim:EngagementCurrencyIdentity>
                     <com:CurrencyCode>USD</com:CurrencyCode>
                     <com:CurrencyId>4862</com:CurrencyId>
                     <com:CurrencyUid>1152921504606851838</com:CurrencyUid>
                  </tim:EngagementCurrencyIdentity>
                  <tim:NewTotalAdjustedAmount>100</tim:NewTotalAdjustedAmount>
                  <tim:TimeCardIdentities>
                     <tim:PwsVersionedTimecardRef>
                        <com:TimecardId>45639608</com:TimecardId>
                        <com:TimecardType>T</com:TimecardType>
                        <com:TimecardUid>1152921504652486584</com:TimecardUid>
                     </tim:PwsVersionedTimecardRef>
                  </tim:TimeCardIdentities>
               </tim:PwsTimeWriteUpDownOrder>
            </tim:WriteUpDownOrders>
         </pws:serviceRequest>
      </pws:PwsWriteUpDownTime>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsWriteUpDownTime 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-06T17:18:38.6934436Z
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>
      <PwsWriteUpDownTimeResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsWriteUpDownTimeResult 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-08T18:09:23.195337Z</ServerTimestampUtc>
            <a:TimeCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsTimecardRef>
                  <b:ReferenceId i:nil="true"/>
                  <b:TimecardId>45639608</b:TimecardId>
                  <b:TimecardType>T</b:TimecardType>
                  <b:TimecardUid>1152921504652486584</b:TimecardUid>
               </b:PwsTimecardRef>
            </a:TimeCardIdentities>
         </PwsWriteUpDownTimeResult>
      </PwsWriteUpDownTimeResponse>
   </s:Body>
</s:Envelope>

PwsWriteUpDownTime - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

10110CurrencyIdentityRequiredA currency identity must be specified.
20051InvalidValueForTimeCardTypeThe specified value for time card type is invalid. Valid values are T for Time Card and R for Reported Time Off.
50024EntityNotFoundTime Card was not found. Another user may have deleted it.
57530CurrencyNotValidForAccountThe specified currency is not enabled for this account.
64365OneOrMoreTimeCardsIneligibleForAdjustment

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



Related content

PwsTimeWriteUpDownOrder
PwsTimeWriteUpDownOrder
Read with this
PwsWriteUpDownCost
PwsWriteUpDownCost
More like this
PwsAdjustTimeDescription
PwsAdjustTimeDescription
More like this
PwsRevalueTime
PwsRevalueTime
More like this
PwsSplitTimeCards
PwsSplitTimeCards
More like this
PwsRevalueCost
PwsRevalueCost
More like this