Versions Compared

Old Version 1

changes.mady.by.user Min Zeng

Saved on

compared with

New Version Current

changes.mady.by.user Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Request Format


Panel
titlePwsAdjustCostDisbursedAmount Request


Request Elements


PwsVersionedCostCardRef unique key identifying Card
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 a monetary adjustment to a time or cost card.  This is not applicable to this service.CostCardIdentities
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
NewDescriptionString (1000)NoThe description to be added / updated to the cost card. If omitted, the cost card's description will be cleared.
2-night hotel stay


Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<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:PwsAdjustCostDescription>PwsAdjustCostDisbursedAmount>
         <pws:serviceRequest>
            <req:SessionTicket>AYqurzyaruwg84zm4AOdBA==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>other</com:AdjustmentCodeName>
            </tim:AdjustmentCodeIdentity>
            <tim:AdjustmentOrders>
               <tim:CostCardIdentities>PwsCostDisbursedAmountAdjustmentOrder>
                  <tim:PwsVersionedCostCardRef>CostCardIdentity>
                     <com:CostCardUid>1152921504614703247</com:CostCardUid>
                  </tim:PwsVersionedCostCardRef>:CostCardIdentity>
                  <tim:NewIncurredOpsCurrencyIdentity>
                     <com:OpsCurrencyCode>USD</com:OpsCurrencyCode>
                  </tim:CostCardIdentities>/tim:NewIncurredOpsCurrencyIdentity>
                  <tim:NewTotalAmountDisbursedCurrency>1122.33</tim:NewTotalAmountDisbursedCurrency>
                  <tim:NewTotalAmountIncurredCurrency>1000</tim:NewTotalAmountIncurredCurrency>
                  <tim:Explanation>Made a mistake earlier</tim:Explanation>:NewVatAmountIncurredCurrency>23</tim:NewVatAmountIncurredCurrency>
                  </tim:PwsCostDisbursedAmountAdjustmentOrder>
            </tim:AdjustmentOrders>
            <tim:NewDescription>2-nightExplanation>Cost hotelCard stay<Adjustment</tim:NewDescription>Explanation>
         </pws:serviceRequest>
      </pws:PwsAdjustCostDescription>PwsAdjustCostDisbursedAmount>
   </soapenv:Body>
</soapenv:Envelope>

...

Panel
titlePwsAdjustCostDisbursedAmount responseResponse
  • PwsAdjustCostDescriptionResponsePwsAdjustCostDisbursedAmountResponse

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 updatedadjusted.

Response Usage Example(s)

...

Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustCostDescriptionResponse<PwsAdjustCostDisbursedAmountResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostDescriptionResult<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-06T1607T20:0629:5957.6092232Z<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>
         </PwsAdjustCostDescriptionResult>PwsAdjustCostDisbursedAmountResult>
      </PwsAdjustCostDescriptionResponse>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.

...