Versions Compared

Old Version 13

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version Current

changes.mady.by.user Luke Wright

Saved on

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. For example, ListType is used to control whether to return projects for use in time or cost entry or expense management. This service is typically used for retrieving projects to use on time cards or cost cards. ListType determines which context. There are three values: T (Time Entry), C (Expense Entry), EM (Expense Management). In each mode, there may be additional contextual information:

  • T: A date range for time entry, and the resource time is being entered for,
  • C: An expense document type, and the resource expenses are being entered for (if applicable).
  • EM: No addiional contexrt

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

No

false

Applies to ListType "CT" and "TC". If set to 'true', the project is results will be limited to projects that are available either for time entry or cost entry respectively.

false

EndDate

DateTime

No


Applies only for ListType = "T". The end date of a projectof the time entry date range in question.


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. Applies only for ListType "C" or "T". May not be set to 'true' for ListType "EM".

true

ProjectIdentity

PwsProjectRef

No


The identities of a project that user is searching forBy specifying a value for ProjectIdentity, you can retrieve the details for a specific project. Click here for more information.


ResourceIdentity

PwsResourceRef

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


If list type is "C" and DocumentType is "E" or list type is "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


Applies only for ListType = "T". The start date of the project(s)time entry date range in question.


ProjectIdentities

PwsProjectRef[]

No


The identities of a list of projects that user is searching forBy specifying one or more project identities in ProjectIdentities, you can retrieve the details for a specific set of projects. Click here for more information.


DocumentType

String (1)

No??? Luke: All four document types

"E"

Applies to list type as "EMC". The type of expense document in context for the search:

"C" for Subcontractor invoice

"E" for Expense report

"S" for Soft cost

 "V" for Vendor invoice

E

...

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 satisfy the search criteria. Click here for more information.


...

ErrorNumber

ErrorCode

ErrorText

19096CannotSpecifyResourceForListTypeEmA resource identity may not be specified for list type EM (Expense Management).
54282ProjectNotFoundSpecified project does not exist.
57544ResourceRef is requiredResourceRef is required
64223InvalidValueForListTypeThe specified value for ListType is invalid. Valid values are T for time or C for cost.65421??? [issue 36350] Exactly one of search string, project, and mru flag must be specified.