Overview

This web service retrieves a list of resources that the authenticated user can enter time or cost on behalf of. The result set can be further narrowed down by a search string or a predefined resource (PwsResourceRef)

Request Format

PwsGetOnBehalfOfResources Request

PwsGetOnBehalfOfResources
- serviceRequest: PwsGetOnBehalfOfResourcesRq
  - RequestId: Int32
  - SessionTicket: String
  - BeginDate: DateTime
  - EndDate: DateTime
  - ListType: String (1)
  - MaximumRows: Int32
  - ResourceIdentity: PwsResourceRef
  - SearchString: String (255)

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.	AQ6SEBGgdJSg3aZ5kSDsDg==
BeginDate	DateTime	No	The begin date of the resource history. Resources active between begin and end dates are included in the result set.	2018-01-01z
EndDate	DateTime	No	The end date of the resource history. Resources active between begin and end dates are included in the result set.	2018-12-31z
ListType	String (1)	Yes	The type of on-behalf-of users: C: Cost T: Time	T
MaximumRows	Int32	No	The maximum number of resources to be returned. This value is disregarded if a client is specified in ResourceIdentity.	5
ResourceIdentity	PwsResourceRef	No	These are the identities of the resources that to be fetched. Click here for more information.
SearchString	String (255)	No	A search string to narrow down the results. A resource will be included in the results if the search string matches the resource's display name based upon the criteria. This value is disregarded if a client is specified in ResourceIdentity.

Usage Example(s)

Example 01 - without resource

<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:PwsGetOnBehalfOfResources>
         <pws:serviceRequest>
            <req:SessionTicket>AQ6SEBGgdJSg3aZ5kSDsDg==</req:SessionTicket>
            <tim:BeginDate>2018-01-01z</tim:BeginDate>
            <tim:EndDate>2018-03-31z</tim:EndDate>
            <tim:ListType>T</tim:ListType>
            <tim:MaximumRows>3</tim:MaximumRows>
            <tim:SearchString>br</tim:SearchString>
         </pws:serviceRequest>
      </pws:PwsGetOnBehalfOfResources>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - with resource

<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:PwsGetOnBehalfOfResources>
         <pws:serviceRequest>
            <req:SessionTicket>AQ6SEBGgdJSg3aZ5kSDsDg==</req:SessionTicket>
            <tim:BeginDate>2018-01-01z</tim:BeginDate>
            <tim:EndDate>2018-03-31z</tim:EndDate>
            <tim:ListType>T</tim:ListType>
            <tim:MaximumRows>3</tim:MaximumRows>
            <tim:SearchString>br</tim:SearchString>
         </pws:serviceRequest>
      </pws:PwsGetOnBehalfOfResources>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetOnBehalfOfResources Response

PwsGetOnBehalfOfResourcesResponse
- PwsGetOnBehalfOfResourcesResult: PwsGetOnBehalfOfResourcesRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - Resources: PwsOnBehalfOfResource[]

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.	0
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-12T14:57:19.319861Z
Resources	PwsOnBehalfOfResource[]	The resource that authenticated user can enter time or cost for. Click here for more information.

Response Usage Example(s)

Example 01 - without resource

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetOnBehalfOfResourcesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetOnBehalfOfResourcesResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T14:57:19.319861Z</ServerTimestampUtc>
            <a:Resources xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsOnBehalfOfResource>
                  <b:ResourceDisplayName>Bruce Wayne</b:ResourceDisplayName>
                  <b:ResourceId i:nil="true"/>
                  <b:ResourceReferenceSystemId>BW-01</b:ResourceReferenceSystemId>
                  <b:ResourceUid>1152921504606968725</b:ResourceUid>
                  <b:EmailAddress>bruce@revcorp.doc</b:EmailAddress>
                  <b:FirstName>Bruce</b:FirstName>
                  <b:LastName>Wayne</b:LastName>
                  <b:MiddleName i:nil="true"/>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:DashboardOboFlag>true</b:DashboardOboFlag>
                  <b:ExpenseReportingOboFlag>true</b:ExpenseReportingOboFlag>
                  <b:TimeEntryOboFlag>true</b:TimeEntryOboFlag>
                  <b:TimeOffOboFlag>true</b:TimeOffOboFlag>
               </b:PwsOnBehalfOfResource>
               <b:PwsOnBehalfOfResource>
                  <b:ResourceDisplayName>Gabrielle Gonzalez</b:ResourceDisplayName>
                  <b:ResourceId i:nil="true"/>
                  <b:ResourceReferenceSystemId>023</b:ResourceReferenceSystemId>
                  <b:ResourceUid>1152921504606963004</b:ResourceUid>
                  <b:EmailAddress>Gabrielle@revcorp.min.cnv1</b:EmailAddress>
                  <b:FirstName>Gabrielle</b:FirstName>
                  <b:LastName>Gonzalez</b:LastName>
                  <b:MiddleName i:nil="true"/>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:DashboardOboFlag>true</b:DashboardOboFlag>
                  <b:ExpenseReportingOboFlag>true</b:ExpenseReportingOboFlag>
                  <b:TimeEntryOboFlag>true</b:TimeEntryOboFlag>
                  <b:TimeOffOboFlag>true</b:TimeOffOboFlag>
               </b:PwsOnBehalfOfResource>
            </a:Resources>
         </PwsGetOnBehalfOfResourcesResult>
      </PwsGetOnBehalfOfResourcesResponse>
   </s:Body>
</s:Envelope>

Example 02 - with resource

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetOnBehalfOfResourcesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetOnBehalfOfResourcesResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T15:49:02.3452499Z</ServerTimestampUtc>
            <a:Resources xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsOnBehalfOfResource>
                  <b:ResourceDisplayName>Larry Krakauer</b:ResourceDisplayName>
                  <b:ResourceId i:nil="true"/>
                  <b:ResourceReferenceSystemId>097</b:ResourceReferenceSystemId>
                  <b:ResourceUid>1152921504606963016</b:ResourceUid>
                  <b:EmailAddress>Larry@revcorp.doc</b:EmailAddress>
                  <b:FirstName>Larry</b:FirstName>
                  <b:LastName>Krakauer</b:LastName>
                  <b:MiddleName>A</b:MiddleName>
                  <b:InactiveFlag>false</b:InactiveFlag>
                  <b:DashboardOboFlag>false</b:DashboardOboFlag>
                  <b:ExpenseReportingOboFlag>false</b:ExpenseReportingOboFlag>
                  <b:TimeEntryOboFlag>true</b:TimeEntryOboFlag>
                  <b:TimeOffOboFlag>false</b:TimeOffOboFlag>
               </b:PwsOnBehalfOfResource>
            </a:Resources>
         </PwsGetOnBehalfOfResourcesResult>
      </PwsGetOnBehalfOfResourcesResponse>
   </s:Body>
</s:Envelope>

PwsGetOnBehalfofResourceResult - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
64223	InvalidValueForListType	The specified value for ListType is invalid. Valid values are T for time or C for cost.