Versions Compared

Key

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

...

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


Panel
titlePwsGetTimeEntryTimeOff 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

The EndDate and the StartDate defines the period in which the time off hours have been logged against

2018-03-31T00:00:00.000Z

ResourceIdentity

PwsResourceRef

No

The identity of the resource associated with the time off time cards


StartDate

DateTime

Yes

The EndDate and the StartDate defines the period in which the time off hours have been logged against

2018-01-01T00:00:00.000Z

Request Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
<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>

...

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)

...

ErrorNumber

ErrorCode

ErrorText

20001
57545
TimeCardStartDateRequired
ResourceNotFoundThe specified resource does not exist.
64249SpecifiedDateRangeMissingIncompleteOrInvalidA specified date range
start date
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.