Overview

This web service modifies the client amount on a cost 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

PwsWriteUpDownTime
- serviceRequest: PwsWriteUpDownTimeRq
  - RequestId: Int32
  - SessionTicket: String
  - AdjustmentCodeIdentity: PwsAdjustmentCodeRef
  - Explanation: String (1024)
  - WriteUpDownOrders: PwsCostWriteUpDownOrder

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information	1
SessionTicket	String	Yes	Click here for more information	AWuKIeUvHQC5lNzuzE3Ugg==
AdjustmentCodeIdentity	PwsAdjustmentCodeRef	No	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.	Time Card Description update
WriteUpDownOrders	PwsCostWriteUpDownOrder	Yes	This structure represents the key elements associated with a cost 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:PwsWriteUpDownCost>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Ae5AvD6kVj/g6kTMZkFbBQ==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
               <com:AdjustmentCodeUid>1152921504606858479</com:AdjustmentCodeUid>
            </tim:AdjustmentCodeIdentity>
            <tim:Explanation>Correcting Client Amount</tim:Explanation>
            <tim:WriteUpDownOrders>
               <tim:PwsCostWriteUpDownOrder>
                  <tim:CostCardIdentities>
                     <tim:PwsVersionedCostCardRef>
                        <com:CostCardUid>1152921504614693734</com:CostCardUid>
                     </tim:PwsVersionedCostCardRef>
                  </tim:CostCardIdentities>
                  <tim:EngagementCurrencyIdentity>
                     <com:CurrencyCode>USD</com:CurrencyCode>
                  </tim:EngagementCurrencyIdentity>
                  <tim:NewMarkupAmount>75.16</tim:NewMarkupAmount>
               </tim:PwsCostWriteUpDownOrder>
            </tim:WriteUpDownOrders>
         </pws:serviceRequest>
      </pws:PwsWriteUpDownCost>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsWriteUpDownTime Response

PwsWriteUpDownCostResponse
- PwsWriteUpDownCostResult: PwsWriteUpDownCostRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- CostCardIdentities: PwsCostCardRef

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	1
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information	2019-11-11T22:55:17.9046695Z
CostCardIdentities	PwsCostCardRef	The identities of the cost cards that were updated.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsWriteUpDownCostResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsWriteUpDownCostResult 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-11T22:55:17.9046695Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardId>7846758</b:CostCardId>
                  <b:CostCardUid>1152921504614693734</b:CostCardUid>
                  <b:ReferenceId i:nil="true"/>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsWriteUpDownCostResult>
      </PwsWriteUpDownCostResponse>
   </s:Body>
</s:Envelope>

PwsWriteUpDownCost - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
10110	CurrencyIdentityRequired	A currency identity must be specified.
50024	EntityNotFound	Cost Card was not found. Another user may have deleted it.
57530	CurrencyNotValidForAccount	The specified currency is not enabled for this account.
64365	OneOrMoreCostCardsIneligibleForAdjustment	Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment.

API Documentation

PwsWriteUpDownCost

Analytics