Versions Compared

Key

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

...

This web service allows user to search for projects or a single project .  using a specified set of criteria. Use ListType to control whether to return projects for use in time or cost entry. . This service will be used primarily in two places for expense entry:

Request Format

Panel
titlePwsSearchProjects Request
  • PwsSearchProjects
    • serviceRequest: PwsSearchProjectsRq

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

AYnZTqq32MHctd+MESbzaQ==

AvailableProjectsOnlyFlag

Boolean





EndDate

DateTime

No


The end date of a project


ListType

String

Yes


The type of project list:

"C" for cost

"T" for time


MaximumRows

Int32

No


The maximum number of records to be returned. This value is disregarded if a project is specified in ProjectIdentity or a list of projects are specified in ProjectIdentities.


MruFlag

Boolean

No

false

If the MRU (most recently used) flag is set, the MRU list (for time or cost as specified by listType) will be returned.

true

ProjectIdentity

PwsProjectRef

No




ResourceIdentity

PwsResourceRef

Yes




SearchString

String

No




StartDate

DateTime

No




ProjectIdentities

PwsProjectRef[???]

No




DocumentType

String





Request Usage Example(s)

...

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-26T13:42:16.9794797Z

Projects

PwsProjectDescriptor

The list of projects that satisfies the search criteria. Click here for more information.


Response Usage Example(s)

...