Overview

This web service splits one or more cost cards. A split cost card adjustment divides a cost card into two separate 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

PwsSplitCostCards Request

PwsAdjustSplitCostCards
- serviceRequest: PwsAdjustSplitCostCardsRq
  - RequestId: Int32
  - SessionTicket: String
  - AdjustmentCodeIdentity: PwsAdjustmentCodeRef
  - Explanation: String (1024)
  - SplitOrders: PwsCostSplitOrder

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.
Explanation	String (1024)	No	An explanation as to why this adjustment was applied.	Time Card Split
SplitOrders	PwsCostSplitOrder	Yes	This structure contains the unique key fields associated with a location.

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:PwsSplitCostCards>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Ae5AvD6kVj/g6kTMZkFbBQ==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
            </tim:AdjustmentCodeIdentity>
            <tim:Explanation>?</tim:Explanation>
            <tim:SplitOrders>
               <tim:PwsCostSplitOrder>
                  <tim:CostCardIdentity>
                     <com:CostCardUid>1152921504614693734</com:CostCardUid>
                  </tim:CostCardIdentity>
                  <tim:SplitClientAmount>1.50</tim:SplitClientAmount>
               </tim:PwsCostSplitOrder>
            </tim:SplitOrders>
         </pws:serviceRequest>
      </pws:PwsSplitCostCards>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSplitCostCards

PwsSplitCostCardsResponse
- PwsSplitCostCardsResult: PwsSplitCostCardsRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCardIdentities: PwsCostCardRef

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	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>
      <PwsSplitCostCardsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSplitCostCardsResult 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-11T22:23:11.0888749Z</ServerTimestampUtc>
            <a:CostCardSplits>
               <a:PwsCostCardSplit>
                  <a:OriginalCostCardIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:CostCardId>7846758</b:CostCardId>
                     <b:CostCardUid>1152921504614693734</b:CostCardUid>
                     <b:ReferenceId i:nil="true"/>
                  </a:OriginalCostCardIdentity>
                  <a:SplitCostCardIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:CostCardId>7846894</b:CostCardId>
                     <b:CostCardUid>1152921504614693870</b:CostCardUid>
                     <b:ReferenceId i:nil="true"/>
                  </a:SplitCostCardIdentity>
               </a:PwsCostCardSplit>
            </a:CostCardSplits>
         </PwsSplitCostCardsResult>
      </PwsSplitCostCardsResponse>
   </s:Body>
</s:Envelope>

PwsSplitCostCards - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
19063	CostCardSplitPercentOutOfRange	The specified split percentage is out of range. Please specify a value greater than 0% and less than 100%.
19064	MustSpecifyCostSplitAmount	When splitting a cost card, either a split client amount, split total amount disbursed currency or a split percent must be specified.
50024	EntityNotFound	Cost Card was not found. Another user may have deleted it.
64365	OneOrMoreTimeCardsIneligibleForAdjustment	Adjustment cannot be completed because one or more cards has changed or is
64573	TimeCardSplitAdjustedAmountOutOfRange	Split adjusted amount must be between zero and the adjusted value of the time card.

API Documentation

PwsSplitCostCards

Analytics