Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

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

PwsResourceRef

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 calculate the daily missing timeconsider 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)

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

Click here for more information.


ResponseId

Int32

Click here for more information.

Status

RequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.

2018-03-12T17:31:31.6073673Z 

TimeAlerts

PwsTimeAlerts

The full details of the time alerts.


Response Usage Example(s)

...