...
- A specified resource (PwsResourceRef). Time cards and time off cards will be for the specified resource. If no resource is specified, time cards associated with the caller's resource, if any, will be returned. If no resource is specified, and the caller is not associated with a resource, an error is raised.
- A specified project (PwsProjectRef). If specified, on time cards associated with the project will be included in the response. This parameter has no bearing on which time off cards are returned in the response.
- A specified time card (PwsTimeCardRef). This can be the identity of a time card or a time off card. If specified, the results will be limited to the specified time card or time off card. Note that the specified time card must also satisfy any other applicable criiteria criteria to be included in the response.
- Various flags control which time cards are included in the results. For example, there are flags based on each time card status to control which statuses are included.
...
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. | AdW9hL5iEq/mAQnDQ5AweA== | |
EndDate | DateTime | Yes | The end date (in midnight UTC) of a time period. The StartDate and EndDate together define the period in which the time cards will be retrieved. The time cards that are to be retrieved must be dated on or after the StartDate and on or prior to the EndDate. | 2018-12-31T00:00:00.000Z | |
IncludeApprovedFlag | Boolean | No | false | If set to 'true', approved time cards will be included in the response. | false |
IncludeBookedAndAssignedRolesFlag | Boolean | No | false | If set to 'true', projects on which the resource is booked for hours during the period or booked or requested on a role that is assigned to a task that is active during the period are included, regardless of whether time cards exist. Active tasks are tasks whose planned dates overlap with this period, or whose planned dates are prior to the period but is not marked complete. | true |
IncludeDraftFlag | Boolean | No | false | If set to 'true', draft time cards will be included in the response. | true |
IncludeReferencedTasksOnlyFlag | Boolean | No | false | If set to 'true', only tasks that are referred to by existing time cards will be included in the response. | true |
IncludeReferencedTimeOffReasonsOnlyFlag | Boolean | No | false | If set to 'true', only time off reaons that are referred to by existing time off cards will be included in the response. | true |
IncludeRejectedFlag | Boolean | No | false | If set to 'true', rejected time cards will be included in the response. | false |
IncludeSubmittedFlag | Boolean | No | false | If set to 'true', submitted time cards will be included in the response. | true |
IncludeTimeCardsFlag | Boolean | No | false | If set to 'true', time cards (as opposed to time off cards) will be included in the response. | true |
IncludeTimeOffCardsFlag | Boolean | No | false | If set to 'true, time off cards will be included in the response. | false |
ProjectIdentity | Yes/No The ResourceIdentity and ProjectIdentity fields are not required, but practically speaking one of them should always be specified. The reason they aren't technically required is that we will get time cards for the user making the API call. However, if that user has no resource profile, you'll get a 50406 error. Since most API users never enter time, you'll almost certainly encounter this. | ||||
ResourceIdentity | Yes/No | The ResourceIdentity and ProjectIdentity fields are is not required, but practically speaking one of them should always be specified. The reason they aren't technically required is that we will get time cards for the user making the API callfield is not required because we'll fall back to the user/resource that the web service request came from. However, if that user has no resource profile, you'll get a 50406 error. Since most API users never enter time, you'll almost certainly encounter this. | |||
StartDate | DateTime | Yes | The start date (in midnight UTC) of a time period. The StartDate and EndDate together define the period in which the time cards will be retrieved. The time cards that are to be retrieved must be dated on or after the StartDate and on or prior to the EndDate. | 2018-01-01T00:00:00.000Z | |
IncludeTaskHierarchyFlag | Boolean | No | false | If set to 'true', all the entire task hierarchy of the task associated with the time card(s) will be included. | false |
AutoMemorizeBookedAndAssignedRolesFlag | Boolean | No | false | If set to 'true', anything that was on the timesheet last week will be on it this week. If set to 'false', timesheet start from scratch each week. This is intended for internal use and you likely want to set this to false. | false |
IncludeMemorizedRolesAndTasksFlag | Boolean | No | false | If set to 'true', memorized roles and tasks will be included in the response. Memorized roles and tasks are roles that may not have any time cards associated with them, but have been explicitly added to a resource's time sheet through the Projector UI. | false |
RespectMemorizedRemovedRolesAndTasksFlag | Boolean | No | false | If set to 'true', roles and tasks that were removed from the timesheet will be excluded from the response. Again, this refers to rows on a resource's time sheet that may be connected to tasks that the resource is assigned to, but have been explicitly removed from the resource's timesheet through the Projector UI. | false |
TimeCardIdentity | No | Identity of the time card, if requesting a single time card. This can refer to a time card or a time off card. |
...
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-06T20:16:49.6052125Z |
Locations | The location(s) associated with the time card(s). | ||
TimeEntryProjects | The project(s) associated with the time card(s). The actual time cards included in the response are grouped by project here. | ||
TimeEntryTimeOff | The time off reason(s) associated with the time card(s). The actual time off cards included in the response are grouped by time off reason here. |
...