PwsAdjustCostExpenseType
Overview
This web service updates the expense type 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
- PwsAdjustCostExpenseType
- serviceRequest: PwsAdjustTimeDescriptionRq
- RequestId: Int32
- SessionTicket: String
- AdjustmentCodeIdentity: PwsAdjustmentCodeRef
- CostCardIdentities: PwsVersionedCostCardRef [1..100]
- Explanation: String (1024)
- NewExpenseTypeIdentity: PwsExpenseTypeRef
- ReportOnlyFlag: Boolean
- serviceRequest: PwsAdjustTimeDescriptionRq
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 | AWuKIeUvHQC5lNzuzE3Ugg== | |
AdjustmentCodeIdentity | PwsAdjustmentCodeRef | No | This structure represents the unique key fields associated with identifying an adjustment code. | ||
CostCardIdentities | PwsVersionedCostCardRef [1..100] | Yes | This structure identifies the cost card(s) that will be be adjusted. Cost Cards can be identified with a CostCardUid. | ||
Explanation | String (1024) | No | An explanation as to why this adjustment was applied. | Correct Expense Type for Reporting purposes | |
NewExpenseTypeIdentity | Yes | The expense type that will be applied to the cost card(s) | |||
ReportOnlyFlag | Boolean | No | If set to "true", the cost card adjustment process is exercised, but not completed. If there is any error triggered during the adjustment process, it will be reported in the response. | false |
Request Usage Example(s)
Response Format
- PwsAdjustCostExpenseTypeResponse
- PwsAdjustCostExpenseTypeResult: PwsAdjustCostExpenseTypeRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- CostCardIdentities: PwsCostCardRef [1..100]
- PwsAdjustCostExpenseTypeResult: PwsAdjustCostExpenseTypeRs
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-08T20:29:17.5581789Z |
CostCardIdentities | PwsCostCardRef [1..100] | The identities of the time cards that were updated. |
Response Usage Example(s)
PwsCostExpenseType - 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 Expense Type: Expense Type was not found. Another user may have deleted it. |
50024 | EntityNotFound | Time Card was not found. Another user may have deleted it. |