PwsGetResourceExpenseSchedule
Overview
This web service retrieves a resource's expense schedule per day within a given date range.
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
- PwsGetResourceExpenseSchedule
- serviceRequest: PwsGetResourceExpenseScheduleRq
- RequestId: Int32
- SessionTicket: String
- EndDate: DateTime
- ResourceIdentity: PwsResourceRef
- StartDate: DateTime
- ExpenseDocumentIdentity: PwsExpenseDocumentRef
- serviceRequest: PwsGetResourceExpenseScheduleRq
Request Elements
Element | Data Type | Required? | Description | Sample Data |
---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | |
String | Yes | Click here for more information. | AfMtiadjKEErha/5LNfifA== | |
EndDate | DateTime | Yes | The EndDate and the StartDate (in UTC format) defines the date range that will be applied as a filter in the search | 2018-03-31T00:00:00.000Z |
ResourceIdentity | No | The resource identity when acting on behalf of another user. If this value is not set, the expense schedule associated with the authenticated user will be included in the response | ||
StartDate | DateTime | Yes | See EndDate | 2018-03-01T00:00:00.000Z |
ExpenseDocumentIdentity | PwsExpenseDocumentRef | No | If supplied and the expense document's disbursing cost center differs from the resource's current cost center, expense document's disbursing cost center is used to look up the expense schedule. It applies to rare cases such as resource submitted the expense document while in cost center A, then moves to cost center B. |
Request Usage Example(s)
Response Format
- PwsGetResourceExpenseScheduleResponse
- PwsGetResourceExpenseScheduleResult: PwsGetResourceExpenseScheduleRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ExpenseSchedule: PwsExpenseScheduleDay[]
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information | 1 |
Status | Click here for more information | Ok | |
DateTime | Click here for more information | 2018-03-21T17:54:57.0414972Z | |
ExpenseSchedule | The full details of the resource's expense schedule per day |
Response Usage Example(s)
PwsGetResourceExpenseSchedule - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
10103 | NothingToDo | There is nothing to do. |
20024 | StartDateRequiredForGetResourceSchedule | A start date must be specified. |
20025 | InvalidValueForResourceScheduleStartDate | The specified start date must be expressed as midnight UTC on the desired date. |
20026 | EndDateRequiredForGetResourceSchedule | An end date must be specified |
20027 | InvalidValueForResourceScheduleEndDate | The specified end date must be expressed as midnight UTC on the desired date. |
50045 | ViewPermissionDenied | You do not have permission to view this item. |
57545 | ResourceNotFound | The specified resource does not exist. |