Overview
This service is used to retrieve a list of time alerts (PwsTimeAlerts) for the resource. Alerts are generated for weeks containing rejected or incomplete time cards, draft time cards and missing time. This service can operate in two modes:
...
| 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. | ARgBFuS/0LDcPCTXeih6XQ== | ||||
CountOnly | Boolean | No | false | If set to 'true', the web service will include only a count of time alerts. If set to 'false", the web service will return full details of the time alerts. | false |
IncludeDraftFlag | Boolean | One of IncludeDraftFlag, IncludeMissingTimeFlag, and/or IncludeRejectedOrIncompleteFlag is required | false | If set to 'true', the web service will return draft time alerts. | true |
IncludeMissingTimeFlag | Boolean | See InlcudeDraftFlag | false | If set to 'true', the web service will return missing time alerts. | true |
IncludeRejectedOrIncompleteFlag | Boolean | See IncludeDraftFlag | false | If set to 'true', the web service will return rejected or incomplete time alerts. | true |
MinAlertsDate | DateTime | *** deprecated *** | *** deprecated *** | *** This field has been deprecated *** |
ResourceIdentity | Yes |
The identity of the resource associated with the time alerts |
. | |
AlertsPeriodType | String |
No |
W | The alerts period type, valid values include: "D" for day "W" for week "M" for month "A" for accounting period | M |
MissingTimeCalculateDailyFlag | Boolean |
false
No | Installation's setting | Determines how missing time is calculated. If set to 'true', the web service will |
consider there to be missing time on a day if less hours were reported for the day than were expected. If 'false', a resource is not considered to have missing time unless the total hours reported for the week is less than what is expected for the entire week. | false |
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:PwsGetTimeAlerts>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>ARgBFuS/0LDcPCTXeih6XQ==</req:SessionTicket>
<tim:CountOnly>false</tim:CountOnly>
<tim:IncludeDraftFlag>true</tim:IncludeDraftFlag>
<tim:IncludeMissingTimeFlag>true</tim:IncludeMissingTimeFlag>
<tim:IncludeRejectedOrIncompleteFlag>true</tim:IncludeRejectedOrIncompleteFlag>
<tim:ResourceIdentity>
<com:ResourceReferenceSystemId>IT (USA) - 10</com:ResourceReferenceSystemId>
</tim:ResourceIdentity>
<tim:AlertsPeriodType>M</tim:AlertsPeriodType>
<tim:MissingTimeCalculateDailyFlag>false</tim:MissingTimeCalculateDailyFlag>
</pws:serviceRequest>
</pws:PwsGetTimeAlerts>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | 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-12T17:31:31.6073673Z |
TimeAlerts | The full details of the time alerts |
. |
Response Usage Example(s)
...
- 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. |
| 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. |
| 57545 | ResourceNotFound | The specified resource does not exist. |