/
PwsGetTimeEntryTimeOff

PwsGetTimeEntryTimeOff

Owned by Bettina Borces
Last updated: Jan 30, 2025

Overview


This web service retrieves a list of time off cards for a resource (PwsResourceRef). If no resource is specified, the resource associated with the caller is used. The time off cards in the response are grouped by time off reason (PwsTimeEntryTimeOff).


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 Method


PwsGetTimeEntryTimeOff Request

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.

AQ2+Jbbi2PGY7DYzq356oQ==

EndDate

DateTime

Yes

Together, the StartDate and EndDate define the period for which to retrieve time off cards.

2018-03-31T00:00:00.000Z

ResourceIdentity

PwsResourceRef

No

The identity of the resource associated with the time off time cards. If not specified, the resource linked to the caller is used.


StartDate

DateTime

Yes

Together, the StartDate and EndDate define the period for which to retrieve time off cards.

2018-01-01T00:00:00.000Z

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:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetTimeEntryTimeOff>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AQ2+Jbbi2PGY7DYzq356oQ==</req:SessionTicket>
            <tim:EndDate>2018-03-31T00:00:00.000Z</tim:EndDate>
            <tim:ResourceIdentity>
               <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
            </tim:ResourceIdentity>
            <tim:StartDate>2018-01-01T00:00:00.000Z</tim:StartDate>
         </pws:serviceRequest>
      </pws:PwsGetTimeEntryTimeOff>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetTimeEntryTimeOff Response

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


Status

RequestStatus

Click here for more information


ServerTimestampUtc

DateTime

Click here for more information


TimeEntryTimeOff

PwsTimeEntryTimeOff[]

The complete details associated with a time off time card


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetTimeEntryTimeOffResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetTimeEntryTimeOffResult 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-08T21:53:21.5033405Z</ServerTimestampUtc>
            <a:TimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>94</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Family Responsibility</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606861848</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>96</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Floater Holiday</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606861701</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>120</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Illness</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606858294</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>121</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Jury Duty</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606858296</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>122</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Maternity</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606861851</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>123</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Military Duty</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606861854</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>131</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Paternity</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606861852</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>132</a:SortOrder>
                  <a:TimeOffCards/>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Personal Day</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606858295</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
               <a:PwsTimeEntryTimeOff>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:MinutesYearToDate>0</a:MinutesYearToDate>
                  <a:SortOrder>148</a:SortOrder>
                  <a:TimeOffCards>
                     <a:PwsTimeOffCardDetail>
                        <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <TimecardId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <TimecardType xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">R</TimecardType>
                        <TimecardUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504608460883</TimecardUid>
                        <a:Description i:nil="true"/>
                        <a:DescriptionClearFlag>false</a:DescriptionClearFlag>
                        <a:RejectedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:RejectedReason i:nil="true"/>
                        <a:RejectedTimestamp i:nil="true"/>
                        <a:Status>Submitted</a:Status>
                        <a:WorkDate>2018-03-06T00:00:00Z</a:WorkDate>
                        <a:WorkMinutes>480</a:WorkMinutes>
                        <a:Timestamp>AAAAAA64Nlc=</a:Timestamp>
                        <a:CardStatus>S</a:CardStatus>
                        <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:TimeOffReasonId i:nil="true"/>
                           <b:TimeOffReasonName>Vacation</b:TimeOffReasonName>
                           <b:TimeOffReasonUid>1152921504606858293</b:TimeOffReasonUid>
                        </a:TimeOffReasonIdentity>
                     </a:PwsTimeOffCardDetail>
                  </a:TimeOffCards>
                  <a:TimeOffReasonIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:TimeOffReasonId i:nil="true"/>
                     <b:TimeOffReasonName>Vacation</b:TimeOffReasonName>
                     <b:TimeOffReasonUid>1152921504606858293</b:TimeOffReasonUid>
                  </a:TimeOffReasonIdentity>
               </a:PwsTimeEntryTimeOff>
            </a:TimeEntryTimeOff>
         </PwsGetTimeEntryTimeOffResult>
      </PwsGetTimeEntryTimeOffResponse>
   </s:Body>
</s:Envelope>

PwsGetTimeEntryTimeOff - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

57545ResourceNotFoundThe specified resource does not exist.
64249SpecifiedDateRangeMissingIncompleteOrInvalidA specified date range was missing, incomplete or invalid. Both the start and end dates must be specified, and the start date may not be after the end date.

Related content