Overview

This service is used to suppress one or more time alerts. Currently, only missing time alerts may be suppressed. Once suppressed, the alert will no longer appear in the alerts on the time entry page. However, suppressing the alert will not prevent it from triggering or being included in a missing time email.

Request Format

PwsDismissTimeAlerts Request

PwsDismissTimeAlerts
- serviceRequest: PwsDismissTimeAlertsRq
  - RequestId: Int32
  - SessionTicket: String
  - DraftTimeAlertDates: DateTime[]
  - MissingTimeAlertDates: DateTime[]
  - RejectedTimeAlertDates: DateTime[]
  - ResourceIdentity: PwsResourceRef

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.	1
SessionTicket	String	Yes	Click here for more information.	ARgBFuS/0LDcPCTXeih6XQ==
DraftTimeAlertDates	DateTime[]	No	Draft time alert date to be suppressed
MissingTimeAlertDates	DateTime[]	Yes - at this time, this is the only type of time alert that can be dismissed	Missing time alert date to be suppressed	2018-03-05T00:00:00.000Z
RejectedTimeAlertDates	DateTime[]	No	Rejected time alert date to be suppressed
ResourceIdentity	PwsResourceRef	No	Identity of resource, if dismissing time alerts on behalf of another resource

Request Usage Example(s)

Example 01

<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:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDismissTimeAlerts>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>ARgBFuS/0LDcPCTXeih6XQ==</req:SessionTicket>
            <tim:MissingTimeAlertDates>
               <arr:dateTime>2018-03-05T00:00:00.000Z</arr:dateTime>
            </tim:MissingTimeAlertDates>
            <tim:ResourceIdentity>
               <com:ResourceDisplayName>Jack Spratt</com:ResourceDisplayName>
               <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
            </tim:ResourceIdentity>
         </pws:serviceRequest>
      </pws:PwsDismissTimeAlerts>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDismissTimeAlerts Response

PwsDismissTimeAlertsResponse
- PwsDismissTimeAlertsResult: PwsDismissTimeAlertsRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime

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	2018-03-12T18:32:45.0410988Z

Response Usage Element(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDismissTimeAlertsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDismissTimeAlertsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T18:32:45.0410988Z</ServerTimestampUtc>
         </PwsDismissTimeAlertsResult>
      </PwsDismissTimeAlertsResponse>
   </s:Body>
</s:Envelope>

PwsDismissTimeAlerts - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
20005	DraftOrRejectedTimeAlertsCannotBeDismissed	Draft or rejected time alerts currently may not be dismissed.
64171	UnexpectedErrorDismissingTimeAlert	There was an unexpected error while trying to dismiss a time alert.