Overview

This web service retrieves a resource's expense schedule per day within a given date range

Request Format

PwsGetResourceExpenseSchedule Request

PwsGetResourceExpenseSchedule
- serviceRequest: PwsGetResourceExpenseScheduleRq
  - RequestId: Int32
  - SessionTicket: String
  - EndDate: DateTime
  - ResourceIdentity: PwsResourceRef
  - StartDate: DateTime
  - ExpenseDocumentIdentity: PwsExpenseDocumentRef

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.	AfMtiadjKEErha/5LNfifA==
EndDate	DateTime	Yes	The EndDate and the StartDate (in UTC format) defines the date range that will be applied as a filter in the search	2018-03-31T00:00:00.000Z
ResourceIdentity	PwsResourceRef	No	The resource identity when acting on behalf of another user. If this value is not set, the expense schedule associated with the authenticated user will be included in the response
StartDate	DateTime	Yes	See EndDate
ExpenseDocumentIdentity	PwsExpenseDocumentRef	No	If supplied and the expense document's disbursing cost center differs from the resource's current cost center, expense document's disbursing cost center is used to look up the expense schedule. It applies to rare cases such as resource submitted the expense document while in cost center A, then moves to cost center B.

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:PwsGetResourceExpenseSchedule>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AfMtiadjKEErha/5LNfifA==</req:SessionTicket>
            <tim:EndDate>2018-03-31T00:00:00.000Z</tim:EndDate>
            <tim:StartDate>2018-03-01T00:00:00.000Z</tim:StartDate>
         </pws:serviceRequest>
      </pws:PwsGetResourceExpenseSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetResourceExpenseSchedule Response

PwsGetResourceExpenseScheduleResponse
- PwsGetResourceExpenseScheduleResult: PwsGetResourceExpenseScheduleRs
- - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ExpenseSchedule: PwsExpenseScheduleDay []

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-21T17:54:57.0414972Z
ExpenseSchedule	PwsExpenseScheduleDay []	The full details of the resource's expense schedule per day

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetResourceExpenseScheduleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetResourceExpenseScheduleResult 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-21T17:54:57.0414972Z</ServerTimestampUtc>
            <a:ExpenseSchedule>
               <a:PwsExpenseScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterExpenseFlag>true</a:CanEnterExpenseFlag>
                  <a:Date>2018-03-28T00:00:00Z</a:Date>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
               </a:PwsExpenseScheduleDay>
               <a:PwsExpenseScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterExpenseFlag>true</a:CanEnterExpenseFlag>
                  <a:Date>2018-03-29T00:00:00Z</a:Date>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
               </a:PwsExpenseScheduleDay>
               <a:PwsExpenseScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterExpenseFlag>true</a:CanEnterExpenseFlag>
                  <a:Date>2018-03-30T00:00:00Z</a:Date>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
               </a:PwsExpenseScheduleDay>
               <a:PwsExpenseScheduleDay>
                  <a:AccountingPeriodClosedFlag>false</a:AccountingPeriodClosedFlag>
                  <a:CanEnterExpenseFlag>true</a:CanEnterExpenseFlag>
                  <a:Date>2018-03-31T00:00:00Z</a:Date>
                  <a:ResourceInactiveFlag>false</a:ResourceInactiveFlag>
               </a:PwsExpenseScheduleDay>
            </a:ExpenseSchedule>
         </PwsGetResourceExpenseScheduleResult>
      </PwsGetResourceExpenseScheduleResponse>
   </s:Body>
</s:Envelope>

PwsGetResourceExpenseSchedule - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
10103	NothingToDo	There is nothing to do.
20024	StartDateRequiredForGetResourceSchedule	A start date must be specified.
20025	InvalidValueForResourceScheduleStartDate	The specified start date must be expressed as midnight UTC on the desired date.
20026	EndDateRequiredForGetResourceSchedule	An end date must be specified
20027	InvalidValueForResourceScheduleEndDate	The specified end date must be expressed as midnight UTC on the desired date.
50045	ViewPermissionDenied	You do not have permission to view this item.
57545	ResourceNotFound	The specified resource does not exist.