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

PwsAdjustCostVendor Request

PwsAdjustCostVendor
- serviceRequest: PwsAdjustCostVendorRq
  - RequestId: Int32
  - SessionTicket: String
  - AdjustmentCodeIdentity: PwsAdjustmentCodeRef
  - AdjustmentOrders: PwsCostVendorAdjustmentOrder [1..100]
  - Explanation: String (1024)

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.
AdjustmentOrders	PwsCostVendorAdjustmentOrder [1..100]	Yes	This structure represents the fields associated with a cost card vendor adjustment.
Explanation	String (1024)	No	An explanation as to why this adjustment was applied.	Updating Paid By

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:PwsAdjustCostVendor>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWuKIeUvHQC5lNzuzE3Ugg==</req:SessionTicket>
            <tim:AdjustmentOrders>
               <tim:PwsCostVendorAdjustmentOrder>
                  <tim:CostCardIdentities>
                     <tim:PwsVersionedCostCardRef>
                        <com:CostCardUid>1152921504614678656</com:CostCardUid>
                     </tim:PwsVersionedCostCardRef>
                  </tim:CostCardIdentities>
                  <tim:NewVendorIdentity>
                     <com:VendorName>Adventure Card</com:VendorName>
                     <com:VendorUid>1152921504607115085</com:VendorUid>
                  </tim:NewVendorIdentity>
               </tim:PwsCostVendorAdjustmentOrder>
            </tim:AdjustmentOrders>
            <tim:Explanation>Updating Paid By</tim:Explanation>
         </pws:serviceRequest>
      </pws:PwsAdjustCostVendor>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsAdjustCostVendor Response

PwsAdjustCostVendor
- PwsAdjustCostVendorResult: PwsAdjustCostVendorRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCardIdentities: PwsCostCardRef [1..100]

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-06T17:18:38.6934436Z
CostCardIdentities	PwsCostCardRef [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>
      <PwsAdjustCostVendorResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostVendorResult 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-11T21:48:51.8366828Z</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>
         </PwsAdjustCostVendorResult>
      </PwsAdjustCostVendorResponse>
   </s:Body>
</s:Envelope>

PwsAdjustCostVendorResponse - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
50024	EntityNotFound	Cost Card was not found. Another user may have deleted it.
50024	EntityNotFound	New Vendor: Vendor was not found. Another user may have deleted it.
65720	SpecifiedVendorNotAvailableForAtLeastOneCard	This vendor is not available for one or more selected cost cards.

API Documentation

PwsAdustCostVendor

Analytics