Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Overview


This web service retrieves a list of time off reasons within an installation. Additionally, if a resource identity (PwsResourceRef) is provided that resource's time off entries within the given time period will also be returned

Request Method


PwsGetTimeEntryTimeOff Request

Request Elements

Element

Data Type

Required?

Description

Sample Data

RequestId

Int32


Click here for more information.


SessionTicket

String


Click here for more information.


EndDate

DateTime




ResourceIdentity

PwsResourceRef




StartDate

DateTime




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



ResponseId

Int32

Click here for more information


Status

RequestStatus

Click here for more information


ServerTimestampUtc

DateTime

Click here for more information


TimeEntryTimeOff

PwsTimeEntryTimeOff [???]



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

20001TimeCardStartDateRequiredThe range start date must be specified.
  • No labels