Overview

This web service inserts or updates time off records given a resource and time off reason (PwsResourceAvailableTimeoffDetail). The service returns the results of the insert or update (PwsSaveResourceAvailableTimeOffResult).

Request Format

PwsSaveResourceAvailableTimeOff Request

PwsSaveResourceAvailableTimeOff
- serviceRequest: PwsSaveResourceAvailableTimeOffRq
  - RequestId: Int32
  - SessionTicket: String
  - AbortOnFailureFlag: Boolean
  - AvailableTimeOffDetail: PwsResourceAvailableTimeoffDetail[]

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AV7pfLYHuvIjk5rCwGgoiQ==
AbortOnFailureFlag	Boolean	No	false	If set to 'true', the request will be aborted once the service encounters a record it cannot process. If set to 'false', it will process all the records that can be process and, fails the ones it cannot.	false
AvailableTimeOffDetail	PwsResourceAvailableTimeoffDetail[]	false		The detailed resource available time off information to be inserted or updated

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:dat="http://projectorpsa.com/DataContracts/Shared/DataAdministration/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsSaveResourceAvailableTimeOff>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AV7pfLYHuvIjk5rCwGgoiQ==</req:SessionTicket>
            <req:AbortOnFailureFlag>false</req:AbortOnFailureFlag>
            <req:AvailableTimeOffDetail>
               <dat:PwsResourceAvailableTimeOffDetail>
                  <dat:AdditionalAvailableMinutes>4800</dat:AdditionalAvailableMinutes>
                  <dat:AsOfDate>2018-01-01T00:00:00.000Z</dat:AsOfDate>
                  <dat:ResourceIdentity>
                     <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
                  </dat:ResourceIdentity>
                  <dat:StartingAvailableMinutes>0</dat:StartingAvailableMinutes>
                  <dat:TimeOffReasonIdentity>
                     <com:TimeOffReasonName>Vacation</com:TimeOffReasonName>
                  </dat:TimeOffReasonIdentity>
               </dat:PwsResourceAvailableTimeOffDetail>
               <dat:PwsResourceAvailableTimeOffDetail>
                  <dat:AdditionalAvailableMinutes>4800</dat:AdditionalAvailableMinutes>
                  <dat:AsOfDate>2018-01-01T00:00:00.000Z</dat:AsOfDate>
                  <dat:ResourceIdentity>
                     <com:ResourceReferenceSystemId>E125</com:ResourceReferenceSystemId>
                  </dat:ResourceIdentity>
                  <dat:StartingAvailableMinutes>0</dat:StartingAvailableMinutes>
                  <dat:TimeOffReasonIdentity>
                     <com:TimeOffReasonName>Vacation</com:TimeOffReasonName>
                  </dat:TimeOffReasonIdentity>
               </dat:PwsResourceAvailableTimeOffDetail>
            </req:AvailableTimeOffDetail>
         </pws:serviceRequest>
      </pws:PwsSaveResourceAvailableTimeOff>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsSaveResourceAvailableTimeOff Response

PwsSaveResourceAvailableTimeOffResponse
- PwsSaveResourceAvailableTimeOffResult: PwsSaveResourceAvailableTimeOffRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Results: PwsSaveResourceAvailableTimeOffResult []

Response Elements

Element	Data Type	Description
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
Results	PwsSaveResourceAvailableTimeOffResult []	The results from the request when the service fails

Response Usage Example(s)

Example 01 - successful response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveResourceAvailableTimeOffResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveResourceAvailableTimeOffResult 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-02T21:31:35.5223547Z</ServerTimestampUtc>
            <a:Results xmlns:b="http://projectorpsa.com/DataContracts/Shared/DataAdministration/"/>
         </PwsSaveResourceAvailableTimeOffResult>
      </PwsSaveResourceAvailableTimeOffResponse>
   </s:Body>
</s:Envelope>

Example 01 - failed response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveResourceAvailableTimeOffResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveResourceAvailableTimeOffResult 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-05T15:08:20.9777785Z</ServerTimestampUtc>
            <a:Results xmlns:b="http://projectorpsa.com/DataContracts/Shared/DataAdministration/">
               <b:PwsSaveResourceAvailableTimeOffResult>
                  <b:AsOfDate>2018-01-01T00:00:00Z</b:AsOfDate>
                  <b:ErrorDetail xmlns:c="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <c:ErrorCode>SpecifiedTimeOffReasonDoesNotExist</c:ErrorCode>
                     <c:ErrorNumber>57567</c:ErrorNumber>
                     <c:ErrorText>The specified time off reason does not exist.</c:ErrorText>
                  </b:ErrorDetail>
                  <b:ResourceIdentity xmlns:c="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <c:ResourceDisplayName i:nil="true"/>
                     <c:ResourceId i:nil="true"/>
                     <c:ResourceReferenceSystemId>E123</c:ResourceReferenceSystemId>
                     <c:ResourceUid i:nil="true"/>
                  </b:ResourceIdentity>
                  <b:TimeOffReasonIdentity xmlns:c="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <c:TimeOffReasonId i:nil="true"/>
                     <c:TimeOffReasonName>Summer Vacation</c:TimeOffReasonName>
                     <c:TimeOffReasonUid i:nil="true"/>
                  </b:TimeOffReasonIdentity>
               </b:PwsSaveResourceAvailableTimeOffResult>
            </a:Results>
         </PwsSaveResourceAvailableTimeOffResult>
      </PwsSaveResourceAvailableTimeOffResponse>
   </s:Body>
</s:Envelope>