Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Overview


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

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. Adjustment codes are required whenever you make some monetary adjustment to a time or cost card.  This is not applicable to this service.
CostCardIdentitiesPwsVersionedCostCardRefYes
This structure represents the unique key fields associated with identifying a cost card.
AdjustmentOrdersPwsCostDisbursedAmountAdjustmentOrderYes
This structure represents the fields associated with a cost card's 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>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AYqurzyaruwg84zm4AOdBA==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>other</com:AdjustmentCodeName>
            </tim:AdjustmentCodeIdentity>
            <!--Optional:-->
            <tim:AdjustmentOrders>
               <!--Zero or more repetitions:-->
               <tim:PwsCostDisbursedAmountAdjustmentOrder>
                  <!--Optional:-->
                  <tim:CostCardIdentity>
                     <com:CostCardUid>1152921504614703247</com:CostCardUid>
                  </tim:CostCardIdentity>
                  <!--Optional:-->
                  <tim:NewIncurredOpsCurrencyIdentity>
                     <!--Optional:-->
                     <com:OpsCurrencyCode>USD</com:OpsCurrencyCode>
                  </tim:NewIncurredOpsCurrencyIdentity>
                  <!--Optional:-->
                  <tim:NewTotalAmountDisbursedCurrency>1122.33</tim:NewTotalAmountDisbursedCurrency>
                  <tim:NewTotalAmountIncurredCurrency>1000</tim:NewTotalAmountIncurredCurrency>
                  <tim:NewVatAmountIncurredCurrency>23</tim:NewVatAmountIncurredCurrency>
                  </tim:PwsCostDisbursedAmountAdjustmentOrder>
            </tim:AdjustmentOrders>
            <!--Optional:-->
            <tim:Explanation>Made a mistake</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
CostCardIdentitiesPwsCostCardRefThe 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>
      <PwsAdjustCostDisbursedAmountResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostDisbursedAmountResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <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:CostCardId i:nil="true"/>
                  <b:CostCardUid>1152921504614703247</b:CostCardUid>
                  <b:ReferenceId i:nil="true"/>
               </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.




  • No labels