Overview

This web service is used in the context of a service contract to transfer hours from a contract line item to a contract line item associated with an overage project.

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

PwsTransferOverageHours

PwsAdjustTimeUserDefinedField
- serviceRequest: PwsAdjustTimeUserDefinedFieldRq
  - RequestId: Int32
  - SessionTicket: String
  - TransferOrders: PwsOverageTransferOrder

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==
TransferOrders	PwsOverageTransferOrder	No	This structure represents the fields associated with a service contract overage hours transfer

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:PwsTransferOverageHours>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWuKIeUvHQC5lNzuzE3Ugg==</req:SessionTicket>
            <tim:TransferOrders>
               <tim:PwsOverageTransferOrder>
                  <tim:ActualsCutoffDate>2019-10-14T00:00:00.000Z</tim:ActualsCutoffDate>
                  <tim:ContractLineItemIdentity>
                     <com:ContractLineItemUid>1152921504607111583</com:ContractLineItemUid>
                  </tim:ContractLineItemIdentity>
               </tim:PwsOverageTransferOrder>
            </tim:TransferOrders>
         </pws:serviceRequest>
      </pws:PwsTransferOverageHours>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsTransferOverageHours Response

PwsTransferOverageHoursResponse
- PwsTransferOverageHoursResult: PwsTransferOverageHoursRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - TransferResults: PwsOverageTransferResult

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
TransferResults	PwsOverageTransferResult	The identities of the contract line items that were affected

Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsTransferOverageHoursResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsTransferOverageHoursResult 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-07T21:08:59.2772811Z</ServerTimestampUtc>
            <a:TransferResults>
               <a:PwsOverageTransferResult>
                  <a:AffectedContractLineItemIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:PwsContractLineItemRef>
                        <b:ContractLineItemCode>P001552-CL1</b:ContractLineItemCode>
                        <b:ContractLineItemId>264607</b:ContractLineItemId>
                        <b:ContractLineItemUid>1152921504607111583</b:ContractLineItemUid>
                     </b:PwsContractLineItemRef>
                     <b:PwsContractLineItemRef>
                        <b:ContractLineItemCode>P001552-CL2</b:ContractLineItemCode>
                        <b:ContractLineItemId>264608</b:ContractLineItemId>
                        <b:ContractLineItemUid>1152921504607111584</b:ContractLineItemUid>
                     </b:PwsContractLineItemRef>
                  </a:AffectedContractLineItemIdentities>
                  <a:ReferenceIdentity i:nil="true"/>
               </a:PwsOverageTransferResult>
            </a:TransferResults>
         </PwsTransferOverageHoursResult>
      </PwsTransferOverageHoursResponse>
   </s:Body>
</s:Envelope>

PwsTransferOverageHours - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
50024	EntityNotFound	Contract Line Item was not found. Another user may have deleted it.
64138	CannotTransferOverageDueToWrongCliType	This adjustment is only supported for contract line items that support contracted hours and overages.
64142	CannotTransferOverageDueToNoPriorPeriod	There is no completed contract period prior to the cutoff date.
64157	CannotTransferOverageDueToNoOverageHours	There are no overage hours to be transferred.

API Documentation

PwsTransferOverageHours

Analytics