/
PwsAdjustCostDisbursedAmount

PwsAdjustCostDisbursedAmount

Overview


This web service updates the disbursed amount on one or more existing cost cards.


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


PwsAdjustCostDisbursedAmount Request


Request Elements


ElementData TypeRequired?DefaultDescriptionSample 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. 
AdjustmentOrdersPwsCostDisbursedAmountAdjustmentOrder [1..100]Yes
This structure represents the fields associated with a cost card disbursed amount adjustment.
Explanation

String (1024)

No
An explanation as to why this adjustment was applied.
made a mistake earlier


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:PwsAdjustCostDisbursedAmount>
         <pws:serviceRequest>
            <req:SessionTicket>AYqurzyaruwg84zm4AOdBA==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>other</com:AdjustmentCodeName>
            </tim:AdjustmentCodeIdentity>
            <tim:AdjustmentOrders>
               <tim:PwsCostDisbursedAmountAdjustmentOrder>
                  <tim:CostCardIdentity>
                     <com:CostCardUid>1152921504614703247</com:CostCardUid>
                  </tim:CostCardIdentity>
                  <tim:NewIncurredOpsCurrencyIdentity>
                     <com:OpsCurrencyCode>USD</com:OpsCurrencyCode>
                  </tim:NewIncurredOpsCurrencyIdentity>
                  <tim:NewTotalAmountDisbursedCurrency>1122.33</tim:NewTotalAmountDisbursedCurrency>
                  <tim:NewTotalAmountIncurredCurrency>1000</tim:NewTotalAmountIncurredCurrency>
                  <tim:NewVatAmountIncurredCurrency>23</tim:NewVatAmountIncurredCurrency>
                  </tim:PwsCostDisbursedAmountAdjustmentOrder>
            </tim:AdjustmentOrders>
            <tim:Explanation>Cost Card Adjustment</tim:Explanation>
         </pws:serviceRequest>
      </pws:PwsAdjustCostDisbursedAmount>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsAdjustCostDisbursedAmount Response

Response Elements


ElementData TypeDescriptionSample 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
CostCardIdentitiesPwsCostCardRef [1..100]The identities of the cost cards that were adjusted.

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustCostDisbursedAmountResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostDisbursedAmountResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2019-11-07T20:29:57.8069156Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardUid>1152921504614703247</b:CostCardUid>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsAdjustCostDisbursedAmountResult>
      </PwsAdjustCostDisbursedAmountResponse>
   </s:Body>
</s:Envelope>

PwsAdjustCostDisbursedAmount - Common Errors and Warnings


ErrorNumber

ErrorCode

ErrorText

10111RequiredFieldMissingA required field is missing: NewIncurredOpsCurrencyIdentity.
10111RequiredFieldMissingA required field is missing: NewTotalAmountIncurredCurrency.
10111RequiredFieldMissingA required field is missing: NewVatAmountIncurredCurrency.
50024EntityNotFoundCost Card was not found. Another user may have deleted it.