Overview
This web service adds/updates a location on one or more existing cost cards.
| Info | ||
|---|---|---|
| ||
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
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
| RequestId | Int32 | No | Click here for more information | 1 | |
| SessionTicket | String | Yes | Click here for more information | AZZLhIFhqIg+w/UlZKyCfg== | |
| AdjustmentCodeIdentity | PwsAdjustmentCodeRef | No | This structure represents the unique key fields associated with identifying an adjustment code. | ||
| CostCardIdentites | PwsVersionedCostCardRef [1..100] | Yes | This structure represents the cost cards that will be adjusted | ||
| Explanation | String (1024) | No | An explanation as to why this adjustment was applied. | Work site location correction | |
| NewLocationIdentity | PwsLocationRef | Yes | The location to be applied to the cost card(s) |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:PwsAdjustCostLocation>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AZZLhIFhqIg+w/UlZKyCfg==</req:SessionTicket>
<tim:AdjustmentCodeIdentity>
<com:AdjustmentCodeName>Other</com:AdjustmentCodeName>
<com:AdjustmentCodeUid>1152921504606858479</com:AdjustmentCodeUid>
</tim:AdjustmentCodeIdentity>
<tim:CostCardIdentities>
<tim:PwsVersionedCostCardRef>
<com:CostCardUid>1152921504614678656</com:CostCardUid>
</tim:PwsVersionedCostCardRef>
</tim:CostCardIdentities>
<tim:Explanation>cost card location update</tim:Explanation>
<tim:NewLocationIdentity>
<com:LocationName>USA - Washington</com:LocationName>
<com:LocationUid>1152921504606863514</com:LocationUid>
</tim:NewLocationIdentity>
</pws:serviceRequest>
</pws:PwsAdjustCostLocation>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
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-11T19:31:07.7851472Z |
| CostCardIdentities | PwsCostCardRef | The identities of the cost cards that were updated. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsAdjustCostLocationResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsAdjustCostLocationResult 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-11T19:31:07.7851472Z</ServerTimestampUtc> <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:PwsCostCardRef> <b:CostCardId>7846634</b:CostCardId> <b:CostCardUid>1152921504614693610</b:CostCardUid> <b:ReferenceId i:nil="true"/> </b:PwsCostCardRef> </a:CostCardIdentities> </PwsAdjustCostLocationResult> </PwsAdjustCostLocationResponse> </s:Body> </s:Envelope> |
PwsAdjustCostLocation - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 50024 | EntityNotFound | New Location: Location was not found. Another user may have deleted it. |
| 64365 | OneOrMoreTimeCardsIneligibleForAdjustment | Adjustment cannot be completed because one or more cards has changed or is ineligible for adjustment. |