Versions Compared

Key

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

...

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

...

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

NoThe


begin date of the resource history. Resources active between begin and end dates are included in the result setApplies 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


The end date of the resource history. Resources active between begin and end dates are included in the result setSee 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: Cost

T: Timeusers:

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 client resource is specified in ResourceIdentity.

5

ResourceIdentity

PwsResourceRef

No


These are the identities of the resources that to be fetchedIf 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 based upon the criteriaThis value is disregarded if a client resource is specified in ResourceIdentity.


...

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 resource resources that the authenticated user can enter time or cost foract 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)

...