...
This web service retrieves the details of a project associated with a time entry given information about a project role, intended to be used for logging time against the role. The caller specifies a project identity (PwsProjectRef) and optionally a role identity (PwsProjectRoleRef). The role identity is necessary when the resource is assigned to multiple roles on the given project. If a resource identity (PwsResourceRef) . In case is supplied, the intent is that time cards will eventually be created for the specified resource. Otherwise the intent is assigned to more than one role, the caller is also given the option of specifying a role identity (PwsProjectRoleRef)to create time cards for the resource associated with the caller. If no resource is specified and the caller is not linked to a resource, an error is raised.
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 |
SessionTicket | String | Yes | Click here for more information. | ARgBFuS/0LDcPCTXeih6XQ== |
EndDate | DateTime | Yes | The EndDate defines the last work date that the time cards could be logged against. Only projects associated with time cards with work dates prior to this EndDate will be included when the web service is executedTogether, the StartDate and EndDate define the date range within which the caller intends to be logging time cards. | 2018-03-06T00:00:00.000Z |
ProjectIdentity | Yes | The identity of the project. | ||
ResourceIdentity | Yes | The identity of the resource. The caller's resource is used if no value is specified for ResourceIdentity. | ||
RoleIdentity | No | The identity of the role role. | ||
StartDate | DateTime | Yes | The EndDate defines the first work date that the time cards could be logged against. Only projects associated with time cards with work dates on or after this StartDate will be included when the web service is executedTogether, the StartDate and EndDate define the date range within which the caller intends to be logging time cards. | 2018-03-04T00:00:00.000Z |
Request Usage Example(s)
...
| Panel | ||||
|---|---|---|---|---|
| PwsGetTimeEntryProjectRoleResponsePwsGetTimeEntryProjectRoleResult: PwsGetTimeEntryProjectRoleRs
| |||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-12T19:39:20.0566836Z |
| TimeEntryProject | PwsTimeEntryProject | The complete information about the project, including information about the role as well. |
Response Usage Example(s)
...
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|
| 20010 | ProjectRequiredForGetTimeEntryProjectRole | A project must be specified. |
| 20011 | TimeEntryProjectRoleStartDateRequired | The range start date must be specified. |
| 20012 | TimeEntryProjectRoleEndDateRequired | The range end date must be specified. |
| 20013 | InvalidValueForTimeEntryProjectRoleStartDate | The specified start date must be expressed as midnight UTC on the desired date. |
| 20014 | InvalidValueForTimeEntryProjectRoleEndDate | The specified end date must be expressed as midnight UTC on the desired date. |