PwsGetAlerts
Overview
This service is used to retrieve alerts for a specified resource. Alerts indicate that the resource has outstanding activity in need of attention, and include Draft, Missing and/or Rejected Time Alerts, Draft and/or Rejected Expense Alerts and Rejected Requested Time Off alerts.
Request Format
- PwsGetAlerts
- serviceRequest: PwsGetAlertsRq
- RequestId: Int32
- SessionTicket: String
- CountOnlyFlag: Boolean
- IncludeDraftTimeFlag: Boolean
- IncludeMissingTimeFlag: Boolean
- IncludeRejectedExpenseFlag: Boolean
- IncludeRejectedOrIncompleteTimeFlag: Boolean
- IncludeUnsubmittedExpenseFlag: Boolean
- MinAlertsDate: DateTime
- ResourceIdentity: PwsResourceRef
- AlertsPeriodType: String
- MissingTimeCalculateDailyFlag: Boolean
- IncludeRejectedOrIncompleteTimeoffFlag: Boolean
- serviceRequest: PwsGetAlertsRq
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. | ASRSfTVqwiAveqJtZvLffA== | |
CountOnlyFlag | Boolean | No | false | If set to 'true', the web service will return only the count of time, cost and time off alerts; if set to 'false' the web service will return full information about each alert | false |
IncludeDraftTimeFlag | Boolean | No | false | If set to 'true', draft time card alerts will be returned | true |
IncludeMissingTimeFlag | Boolean | No | false | If set to 'true', missing time alerts will be returned. | false |
IncludeRejectedExpenseFlag | Boolean | No | false | If set to 'true', rejected expense alerts will be returned. | false |
IncludeRejectedOrIncompleteTimeFlag | Boolean | No | false | If set to 'true, rejected or incomplete time card alerts will be returned. | true |
IncludeUnsubmittedExpenseFlag | Boolean | No | false | false | |
MinAlertsDate *** deprecated *** | DateTime | *** deprecated *** | *** deprecated *** | *** deprecated *** |
|
ResourceIdentity | No | The resource identity when acting on behalf of, if not specified, the authenticated resource identity will be used. | |||
AlertsPeriodType | String | No | 'W' for weekly | The alerts period type: "D" for day, "W" for week "M" for month "A" for accounting period | M |
MissingTimeCalculateDailyFlag | Boolean | No | false | If set to 'true', missing time will be determined on a daily basis. That is, a missing time alert will be generated for any day on which the reported hours are exceeded by the working hours, even if for the week as a whole, the working hours were met. | false |
IncludeRejectedOrIncompleteTimeoffFlag | Boolean | No | false | If set to 'true', rejected or incomplete time off alerts will be returned. | true |
Note: At least one of IncludeDraftTimeFlag, IncludeMissingTimeFlag, IncludeRejectedExpenseFlag, IncludeRejectedOrIncompleteTimeFlag or IncludeUnsubmittedExpenseFlag or IncludeRejectedOrIncompleteTimeoffFlag must be 'true'.
Request Usage Example(s)
Response Format
- PwsGetAlertsResponse
- PwsGetAlertsResult: PwsGetAlertsRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- CostAlerts: PwsCostAlerts
- TimeAlerts: PwsTimeAlerts
- TimeoffAlerts: PwsTimeoffAlert
- PwsGetAlertsResult: PwsGetAlertsRs
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 | ||
ServerTimestampUtc | DateTime | Click here for more information | 2018-03-15T19:19:18.0531862Z |
CostAlerts | The complete information associated with cost alerts | ||
TimeAlerts | The complete information associated with time alerts | ||
TimeoffAlerts | The complete information associated with time off alerts |
Response Usage Example(s)
PwsGetAlerts - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
20065 | InvalidValueForAlertsPeriodType | Specified value for alerts period type is invalid. Valid values are D for day, W for week, M for month and A for accounting period. |