Overview

This web services deletes the available time off for a specific time off reason (PwsTimeOffReasonRef) and resource (PwsResourceRef).

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

PwsDeleteResourceAvailableTimeOff Request

PwsDeleteResourceAvailableTimeOff
- serviceRequest: PwsDeleteResourceAvailableTimeOffRq
  - RequestId: Int32
  - SessionTicket: String
  - EndDate: DateTime
  - ResourceIdentity: PwsResourceRef
  - StartDate: DateTime
  - TimeOffReasonIdentity: PwsTimeOffReasonRef

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.	AUL1Tsqbhar4SWXC5j9T+w==
EndDate	DateTime	No	The EndDate and the StartDate define the period in which the time off hours should be deleted. Leaving EndDate null will result in deleting all available time off hours after the specified StartDate. Leaving StartDate null will result in deleting all available time off hours up until the EndDate. Leaving both null will result deleting all available time off hours.	2018-01-31T00:00:00.000Z
ResourceIdentity	PwsResourceRef	Yes	The resource identity
StartDate	DateTime	No	See EndDate	2018-01-01T00:00:00.000Z
TimeOffReasonIdentity	PwsTimeOffReasonRef	Yes	The time off reason identity

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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteResourceAvailableTimeOff>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AUL1Tsqbhar4SWXC5j9T+w==</req:SessionTicket>
            <req:EndDate>2018-01-31T00:00:00.000Z</req:EndDate>
            <req:ResourceIdentity>
               <com:ResourceDisplayName>Jack Spratt</com:ResourceDisplayName>
               <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
            </req:ResourceIdentity>
            <req:StartDate>2018-01-01T00:00:00.000Z</req:StartDate>
            <req:TimeOffReasonIdentity>
               <com:TimeOffReasonName>Vacation</com:TimeOffReasonName>
               <com:TimeOffReasonUid>1152921504606858293</com:TimeOffReasonUid>
            </req:TimeOffReasonIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteResourceAvailableTimeOff>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteResourceAvailableTimeOff Response

PwsDeleteResourceAvailableTimeOffResponse
- PwsDeleteResourceAvailableTimeOffResult: PwsDeleteResourceAvailableTimeOffRs
  - 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-01T20:47:10.0345768Z

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteResourceAvailableTimeOffResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteResourceAvailableTimeOffResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" 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-01T20:47:10.0345768Z</ServerTimestampUtc>
         </PwsDeleteResourceAvailableTimeOffResult>
      </PwsDeleteResourceAvailableTimeOffResponse>
   </s:Body>
</s:Envelope>

PwsDeleteResourceAvailableTimeOffResponse - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
10116	InvalidDateValueSpecified	The date specified in the field "{FieldName}" in the class "{TypeName}" is invalid or out of range. The time component of the specified date must be midnight UTC.
50024	EntityNotFound	Resource was not found. Another user may have deleted it.
50024	EntityNotFound	Time Off Reason was not found. Another user may have deleted it.

API Documentation

PwsDeleteResourceAvailableTimeOff

Analytics

Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsDeleteResourceAvailableTimeOffResponse - Common Errors and Warnings

Related content

PwsDeleteResourceAvailableTimeOff

[data-colorid=j52vcawvlc]{color:#292a2e} html[data-color-mode=dark] [data-colorid=j52vcawvlc]{color:#d1d2d6}[data-colorid=lwpuiiu94d]{color:#292a2e} html[data-color-mode=dark] [data-colorid=lwpuiiu94d]{color:#d1d2d6}Overview

Request Format

Request Elements

Request Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsDeleteResourceAvailableTimeOffResponse - Common Errors and Warnings

Related content

Overview