Versions Compared

Key

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

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No

Click here for more information

1

SessionTicket

String

Yes

Click here for more information

AYj3Oq2QNy7nW1zbLfuT7Q==

ExcludeReadNotesFlag

Boolean

No

false

If true, notes that have been marked as read by the current user are excluded from the data returned. Applies only when FullDetailFlag is true.

true

IncludeDeletedRolesFlag

Boolean

No

false

If true, roles that have been marked as deleted will be returned.

true

Mode

String

Yes

Applies if FullDetailFlag is set to true:

A to retrieve booked data for roles

R to retrieve requested data for roles

E to retrieve effective data for roles (booked data for booked roles, requested data for requested roles)

A

ProjectIdentities

PwsProjectRef [1-100]

Yes

This structure represents the unique key fields associated with identifying a project role. A role represents demand for labor. This demand is then supplied by a resource assigned to the role. For example, project X needs a social media director which will be staffed by Henry. Roles are booked hours so that the resource and you know who is working on what and when. Project roles can be identified by an ExternalSystemIdentifier or ProjectRoleUid. When specifying a PwsProjectRoleRef as an input to a web service, you may specify one or both the ExternalSystemIdentifier and ProjectRoleUid. However, if you do specify both, they must both refer to the same project role or the project role reference will not be considered valid. When a PwsProjectRoleRef is returned in the response to a web service, both the ExternalSystemIdentifier and ProjectRoleUid will be populated, and guaranteed to refer to a single project role.

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage [1-100]

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.

2024-10-10T2014T20:4920:1610.8718067Z8233214Z

RolesByProject

PwsProjectProjectRoles [1-100]

This structure represents the unique key fields associated with identifying project roles.

...