Versions Compared

Key

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

Overview

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

Request Format

Panel
titlePwsGetOnBehalfOfResources Request
  • PwsGetOnBehalfOfResources
    • serviceRequest: PwsGetOnBehalfOfResourcesRq

Request Elements

...

Element

...

Data Type

...

Required?

...

Default

...

Description

...

Sample Data

...

RequestId

...

Int32

...

No

...

Click here for more information.

...

SessionTicket

...

String

...

Yes

...

Click here for more information.

...

AQ6SEBGgdJSg3aZ5kSDsDg==

...

BeginDate

...

DateTime

...

No

...

Applies only for ListType T. The response will be limited to resources for whom the caller has permission to enter time on behalf of at any point during the date range bounded by BeginDate and EndDate, If ListType is T and BeginDate is not specified, the first day of the current week is used as the BeginDate.

...

2018-01-01z

...

EndDate

...

DateTime

...

No

...

See BeginDate, If ListType is T and EndDate is not specified, the last day of the current week is used as the EndDate.

...

2018-12-31z

...

ListType

...

String (1)

...

Yes

...

The type of on-behalf-of users:

C: Enter cost

T: Enter time

O: Enter time off requests

D: View dashboard

...

T

...

MaximumRows

...

Int32

...

No

...

The maximum number of resources to be returned. This value is disregarded if a resource is specified in ResourceIdentity.

...

5

...

ResourceIdentity

...

PwsResourceRef

...

No

...

If a resource is identifier here, the results will be limited to the specified resource. If the caller does not have on behalf of permissions for the specified resource, an empty list will be returned. 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 caller has the appropriate on behalf of permissions for the resource and the search string matches the resource's display name. This value is disregarded if a resource is specified in ResourceIdentity.

Usage Example(s)

...

languagejava
titleExample 01 - without resource
collapsetrue

...

Overview


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


Info
titleRate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.


Request Format


Panel
titlePwsGetOnBehalfOfResources Request
  • PwsGetOnBehalfOfResources
    • serviceRequest: PwsGetOnBehalfOfResourcesRq

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

AQ6SEBGgdJSg3aZ5kSDsDg==

BeginDate

DateTime

No


Applies only for ListType T. The response will be limited to resources for whom the caller has permission to enter time on behalf of at any point during the date range bounded by BeginDate and EndDate, If ListType is T and BeginDate is not specified, the first day of the current week is used as the BeginDate.

2018-01-01z

EndDate

DateTime

No


See BeginDate, If ListType is T and EndDate is not specified, the last day of the current week is used as the EndDate.

2018-12-31z

ListType

String (1)

Yes


The type of on-behalf-of users:

C: Enter cost

T: Enter time

O: Enter time off requests

D: View dashboard

T

MaximumRows

Int32

No


The maximum number of resources to be returned. This value is disregarded if a resource is specified in ResourceIdentity.

5

ResourceIdentity

PwsResourceRef

No


If a resource is identifier here, the results will be limited to the specified resource. If the caller does not have on behalf of permissions for the specified resource, an empty list will be returned. 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 caller has the appropriate on behalf of permissions for the resource and the search string matches the resource's display name. This value is disregarded if a resource is specified in ResourceIdentity.


Usage Example(s)


Code Block
languagejava
titleExample 01 - without resource
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:PwsGetOnBehalfOfResources>
         <pws:serviceRequest>
            <req:SessionTicket>AQ6SEBGgdJSg3aZ5kSDsDg==</req:SessionTicket>
            <tim:SearchString>br<BeginDate>2018-01-01z</tim:SearchString>BeginDate>
            </pws:serviceRequest><tim:EndDate>2018-03-31z</tim:EndDate>
        </pws:PwsGetOnBehalfOfResources>    <<tim:ListType>T</soapenvtim:Body>
</soapenv:Envelope>
Code Block
languagejava
titleExample 02 - with resource
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:reqListType>
            <tim:MaximumRows>3</tim:MaximumRows>
            <tim:SearchString>br</tim:SearchString>
         </pws:serviceRequest>
      </pws:PwsGetOnBehalfOfResources>
   </soapenv:Body>
</soapenv:Envelope>


Code Block
languagejava
titleExample 02 - with resource
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://projectorpsaschemas.xmlsoap.comorg/DataContractssoap/Requestsenvelope/" xmlns:timpws="http://projectorpsa.com/DataContracts/Shared/TimeAndCostPwsProjectorServices/" xmlns:comreq="http://projectorpsa.com/DataContracts/Shared/CommonRequests/">    <soapenv:Headerxmlns: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>

...

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

StatusRequestStatusClick here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-12T14:57:19.319861Z

Resources

PwsOnBehalfOfResource[]

The resources that the authenticated user can act on behalf of in the requested manner (as specified in ListType). The resources must also meet the additional criteria, if specified. Click here for more information.

Response Usage Example(s)

...

languagexml
titleExample 01 - without resource
collapsetrue

...

here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-12T14:57:19.319861Z

Resources

PwsOnBehalfOfResource[]

The resources that the authenticated user can act on behalf of in the requested manner (as specified in ListType). The resources must also meet the additional criteria, if specified. Click here for more information.


Response Usage Example(s)


Code Block
languagexml
titleExample 01 - without resource
collapsetrue
<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>
                 <PwsGetOnBehalfOfResourcesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"><b:LastName>Wayne</b:LastName>
                 <PwsGetOnBehalfOfResourcesResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><b:MiddleName i:nil="true"/>
                 <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/><b:InactiveFlag>false</b:InactiveFlag>
                 <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <b:DashboardOboFlag>true</b:DashboardOboFlag>
                 <Status xmlns="http<b://projectorpsa.com/CommonServices/">Ok</Status>ExpenseReportingOboFlag>true</b:ExpenseReportingOboFlag>
                 <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-12T14:57:19.319861Z</ServerTimestampUtc> <b:TimeEntryOboFlag>true</b:TimeEntryOboFlag>
                 <a:Resources xmlns<b:TimeOffOboFlag>true</b="http://projectorpsa.com/DataContracts/Shared/Common/">:TimeOffOboFlag>
                  <b:ShowBillableUtilizationOnDashboardFlag>true</b:PwsOnBehalfOfResource>ShowBillableUtilizationOnDashboardFlag>
                  <b:ResourceDisplayName>Bruce Wayne<ShowChargeableUtilizationOnDashboardFlag>true</b:ResourceDisplayName>ShowChargeableUtilizationOnDashboardFlag>
                  <b:ResourceId i:nil="true"/>:ShowProductiveUtilizationOnDashboardFlag>true</b:ShowProductiveUtilizationOnDashboardFlag>
                  <b:ResourceReferenceSystemId>BW-01<ShowTotalUtilizationOnDashboardFlag>true</b:ResourceReferenceSystemId>
  ShowTotalUtilizationOnDashboardFlag>
               </b:PwsOnBehalfOfResource>
               <b:ResourceUid>1152921504606968725</b:ResourceUid>PwsOnBehalfOfResource>
                  <b:EmailAddress>bruce@revcorp.doc<ResourceDisplayName>Gabrielle Gonzalez</b:EmailAddress>ResourceDisplayName>
                  <b:FirstName>Bruce</b:FirstName>:ResourceId i:nil="true"/>
                  <b:LastName>Wayne<ResourceReferenceSystemId>023</b:LastName>ResourceReferenceSystemId>
                  <b:MiddleName i:nil="true"/>ResourceUid>1152921504606963004</b:ResourceUid>
                  <b:InactiveFlag>false<EmailAddress>Gabrielle@revcorp.min.cnv1</b:InactiveFlag>EmailAddress>
                  <b:DashboardOboFlag>true<FirstName>Gabrielle</b:DashboardOboFlag>FirstName>
                  <b:ExpenseReportingOboFlag>true<LastName>Gonzalez</b:ExpenseReportingOboFlag>LastName>
                  <b:TimeEntryOboFlag>true</b:TimeEntryOboFlag>
            MiddleName i:nil="true"/>
     <b:TimeOffOboFlag>true</b:TimeOffOboFlag>             <b:InactiveFlag>false</b:InactiveFlag>
  </b:PwsOnBehalfOfResource>                <b:PwsOnBehalfOfResource>DashboardOboFlag>true</b:DashboardOboFlag>
                  <b:ResourceDisplayName>Gabrielle Gonzalez<ExpenseReportingOboFlag>true</b:ResourceDisplayName>ExpenseReportingOboFlag>
                  <b:ResourceId i:nil="true"/>TimeEntryOboFlag>true</b:TimeEntryOboFlag>
                  <b:ResourceReferenceSystemId>023<TimeOffOboFlag>true</b:ResourceReferenceSystemId>TimeOffOboFlag>
                  <b:ResourceUid>1152921504606963004<ExpenseReportingOboSetting>U</b:ResourceUid>ExpenseReportingOboSetting>
                  <b:EmailAddress>Gabrielle@revcorp.min.cnv1<TimeEntryOboSetting>U</b:EmailAddress>TimeEntryOboSetting>
                  <b:FirstName>Gabrielle<ShowBillableUtilizationOnDashboardFlag>true</b:FirstName>ShowBillableUtilizationOnDashboardFlag>
                  <b:LastName>Gonzalez<ShowChargeableUtilizationOnDashboardFlag>true</b:LastName>ShowChargeableUtilizationOnDashboardFlag>
                  <b:MiddleName i:nil="true"/>ShowProductiveUtilizationOnDashboardFlag>true</b:ShowProductiveUtilizationOnDashboardFlag>
                  <b:InactiveFlag>false<ShowTotalUtilizationOnDashboardFlag>true</b:InactiveFlag>ShowTotalUtilizationOnDashboardFlag>
                </b:PwsOnBehalfOfResource>
        <b:DashboardOboFlag>true</b:DashboardOboFlag>    </a:Resources>
         </PwsGetOnBehalfOfResourcesResult>
    <b:ExpenseReportingOboFlag>true</b:ExpenseReportingOboFlag>  </PwsGetOnBehalfOfResourcesResponse>
   </s:Body>
</s:Envelope>       


Code Block
languagejava
titleExample 02 - with resource
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <b:TimeEntryOboFlag>true</b:TimeEntryOboFlag><s:Body>
      <PwsGetOnBehalfOfResourcesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetOnBehalfOfResourcesResult  <b:TimeOffOboFlag>true</b:TimeOffOboFlag>xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages   </b:PwsOnBehalfOfResource>
            </a:Resources>xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsGetOnBehalfOfResourcesResult>       </PwsGetOnBehalfOfResourcesResponse>
   </s:Body>
</s:Envelope> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
     
Code Block
languagejava
titleExample 02 - with resource
collapsetrue
<s:Envelope xmlns:s       <Status xmlns="http://schemasprojectorpsa.xmlsoap.orgcom/soapCommonServices/envelope/">">Ok</Status>
     <s:Body>       <PwsGetOnBehalfOfResourcesResponse<ServerTimestampUtc xmlns="http://projectorpsa.com/PwsProjectorServicesCommonServices/">>2018-03-12T15:49:02.3452499Z</ServerTimestampUtc>
            <PwsGetOnBehalfOfResourcesResult<a:Resources xmlns:ab="http://projectorpsa.com/DataContracts/Shared/TimeAndCostCommon/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">>
               <b:PwsOnBehalfOfResource>
              <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>    <b:ResourceDisplayName>Larry Krakauer</b:ResourceDisplayName>
                  <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId><b:ResourceId i:nil="true"/>
                 <Status xmlns="http<b://projectorpsa.com/CommonServices/">Ok</Status>ResourceReferenceSystemId>097</b:ResourceReferenceSystemId>
                 <ServerTimestampUtc xmlns="http<b://projectorpsa.com/CommonServices/">2018-03-12T15:49:02.3452499Z</ServerTimestampUtc>ResourceUid>1152921504606963016</b:ResourceUid>
                 <a:Resources xmlns<b:b="http://projectorpsa.com/DataContracts/Shared/Common/">EmailAddress>Larry@revcorp.doc</b:EmailAddress>
                  <b:FirstName>Larry</b:PwsOnBehalfOfResource>FirstName>
                  <b:ResourceDisplayName>Larry Krakauer<LastName>Krakauer</b:ResourceDisplayName>LastName>
                  <b:ResourceId i:nil="true"/>MiddleName>A</b:MiddleName>
                  <b:ResourceReferenceSystemId>097<InactiveFlag>false</b:ResourceReferenceSystemId>InactiveFlag>
                  <b:ResourceUid>1152921504606963016<DashboardOboFlag>false</b:ResourceUid>DashboardOboFlag>
                  <b:EmailAddress>Larry@revcorp.doc<ExpenseReportingOboFlag>false</b:EmailAddress>ExpenseReportingOboFlag>
                  <b:FirstName>Larry<TimeEntryOboFlag>true</b:FirstName>TimeEntryOboFlag>
                  <b:LastName>Krakauer<TimeOffOboFlag>false</b:LastName>TimeOffOboFlag>
                  <b:MiddleName>A<ExpenseReportingOboSetting>U</b:MiddleName>ExpenseReportingOboSetting>
                  <b:InactiveFlag>false<TimeEntryOboSetting>U</b:InactiveFlag>TimeEntryOboSetting>
                  <b:DashboardOboFlag>false<ShowBillableUtilizationOnDashboardFlag>true</b:DashboardOboFlag>ShowBillableUtilizationOnDashboardFlag>
                  <b:ExpenseReportingOboFlag>false<ShowChargeableUtilizationOnDashboardFlag>true</b:ExpenseReportingOboFlag>ShowChargeableUtilizationOnDashboardFlag>
                  <b:TimeEntryOboFlag>true<ShowProductiveUtilizationOnDashboardFlag>true</b:TimeEntryOboFlag>ShowProductiveUtilizationOnDashboardFlag>
                  <b:TimeOffOboFlag>false<ShowTotalUtilizationOnDashboardFlag>true</b:TimeOffOboFlag>ShowTotalUtilizationOnDashboardFlag>
                       </b:PwsOnBehalfOfResource>
            </a:Resources>
         </PwsGetOnBehalfOfResourcesResult>
      </PwsGetOnBehalfOfResourcesResponse>
   </s:Body>
</s:Envelope>

...