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 For example, ListType is used 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:or expense management. 

Request Format

Panel
titlePwsSearchProjects Request
  • PwsSearchProjects
    • serviceRequest: PwsSearchProjectsRq
      • RequestId: Int32
      • SessionTicket: String
      • AvailableProjectsOnlyFlag: Boolean
      • EndDate: DateTime
      • ListType: String (1)
      • MaximumRows: Int32
      • MruFlag: Boolean
      • ProjectIdentity: PwsProjectRef
      • ResourceIdentity: PwsResourceRef
      • SearchString: String (255)
      • StartDate: DateTime
      • ProjectIdentities: PwsProjectRef[???]
      • DocumentType: String (1)

...

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

No




EndDate

DateTime

No


The end date of a project


ListType

String (1)

Yes


The type of project list:

"C" for cost

"EM" for expense management

"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


The identities of a project that user is searching for. Click here for more information.


ResourceIdentity

PwsResourceRef

Yes for list type as "C" and "T"


If list type is "C" or "T", then resource identity is required. If list type is "EM", then resource identity must be omitted.


SearchString

String (255)

No


A search string to narrow down the results. A project will be included in the results if the search string matches the project name or code. This value is disregarded if project or projects are specified in ProjectIdentity or ProjectIdentities.

Met

StartDate

DateTime

No


The start date of the project(s)


ProjectIdentities

PwsProjectRef[???]

No


The identities of a list of projects that user is searching for. Click here for more information.


DocumentType

String (1)

No

??? Luke: All four document types

Applies to list type as "EM". The type of expense document:

"C" for Subcontractor invoice

"E" for Expense report

"S" for Soft cost

 "V" for Vendor invoice

E

...