Overview

This web service adds/updates the description on one or more existing cost cards (PwsVersionedCostCardRef).

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

PwsAdjustCostDescription Request

PwsAdjustCostDescription
- serviceRequest: PwsAdjustCostDescriptionRq
  - RequestId: Int32
  - SessionTicket: String
  - AdjustmentCodeIdentity: PwsAdjustmentCodeRef
  - CostCardIdentities: PwsVersionedCostCardRef [1..100]
  - Explanation: String (1024)
  - NewDescription: String (1000)

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	AYqurzyaruwg84zm4AOdBA==
AdjustmentCodeIdentity	PwsAdjustmentCodeRef	No	This structure represents the unique key fields associated with identifying an adjustment code.
CostCardIdentities	PwsVersionedCostCardRef [1..100]	Yes	This structure represents the unique key fields associated with identifying a cost card.
Explanation	String (1024)	No	An explanation as to why this adjustment was applied.	Made a mistake earlier
NewDescription	String (1000)	No	The 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)

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:PwsAdjustCostDescription>
         <pws:serviceRequest>
            <req:SessionTicket>AYqurzyaruwg84zm4AOdBA==</req:SessionTicket>
            <tim:CostCardIdentities>
               <tim:PwsVersionedCostCardRef>
                  <com:CostCardUid>1152921504614703247</com:CostCardUid>
               </tim:PwsVersionedCostCardRef>
            </tim:CostCardIdentities>
            <tim:Explanation>Made a mistake earlier</tim:Explanation>
            <tim:NewDescription>2-night hotel stay</tim:NewDescription>
         </pws:serviceRequest>
      </pws:PwsAdjustCostDescription>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsAdjustCostDescription response

PwsAdjustCostDescriptionResponse
- PwsAdjustCostDescriptionResult: PwsAdjustCostDescriptionRs
  - 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 updated.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustCostDescriptionResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostDescriptionResult 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-06T16:06:59.6092232Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardUid>1152921504614703247</b:CostCardUid>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsAdjustCostDescriptionResult>
      </PwsAdjustCostDescriptionResponse>
   </s:Body>
</s:Envelope>

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

Browser not supported