Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


This web service retrieves a list of time cards (PwsExpenseDocument), based upon a unique project identifier (PwsProjectRef) or resource identifier (PwsResourceRef) or time card identifier (PwsTimecardRef)

Request Format


PwsGetTimeCards Request
  • PwsGetTimeCards
    • serviceRequest: PwsGetTimeCardsRq
      • RequestId: Int32
      • SessionTicket: String
      • EndDate: DateTime
      • IncludeApprovedFlag: Boolean
      • IncludeBookedAndAssignedRolesFlag: Boolean
      • IncludeDraftFlag: Boolean
      • IncludeReferencedTasksOnlyFlag: Boolean
      • IncludeReferencedTimeOffReasonsOnlyFlag: Boolean
      • IncludeRejectedFlag: Boolean
      • IncludeSubmittedFlag: Boolean
      • IncludeTimeCardsFlag: Boolean
      • IncludeTimeOffCardsFlag: Boolean
      • ProjectIdentity: PwsProjectRef
      • ResourceIdentity: PwsResourceRef
      • StartDate: DateTime
      • IncludeTaskHierarchyFlag: Boolean
      • AutoMemorizeBookedAndAssignedRolesFlag: Boolean
      • IncludeMemorizedRolesAndTasksFlag: Boolean
      • RespectMemorizedRemovedRolesAndTasksFlag: Boolean
      • TimeCardIdentity: PwsTimecardRef

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

 

 

Click here for more information.

 

SessionTicket

String

 

 

Click here for more information.

 

EndDate

DateTime

 

 

The end date, the time cards that are to be retrieved must have an actual or planned work date prior to this date. The StartDate and EndDate define the period in which the time cards will be retrieved.

 

IncludeApprovedFlag

Boolean

 

 

If set to 'true', approved time cards will be included in the response

 

IncludeBookedAndAssignedRolesFlag

Boolean

 

 

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.

 

IncludeDraftFlag

Boolean

 

 

If set to 'true', draft time cards will be included in the response

 

IncludeReferencedTasksOnlyFlag

Boolean

 

 

If set to 'true', only tasks that are referred to by existing time cards will be included in the response

 

IncludeReferencedTimeOffReasonsOnlyFlag

Boolean

 

 

If set to 'true', only time off reaons that are referred to by existing time cards will be included in the response

 

IncludeRejectedFlag

Boolean

 

 

If set to 'true', rejected time cards will be included in the response

 

IncludeSubmittedFlag

Boolean

 

 

If set to 'true', submitted time cards will be included in the response

 

IncludeTimeCardsFlag

Boolean

 

 

If set to 'true', time cards associated with a project will be included in the response

 

IncludeTimeOffCardsFlag

Boolean

 

 

If set to 'true, time off cards associated with a time off reason will be included in the response 

 

ProjectIdentity

PwsProjectRef

 

 

Identity of project, if requesting time cards for a single project

 

ResourceIdentity

PwsResourceRef

 

 

This structure represents the unique key fields associated with identifying the resource. If a ResourceIdentity is not specified, the authenticated resource identity will be used. If the resource identity is supplied and, it differs from the authenticated user, the authenticated user must have permission to view the specified resource's time cards, otherwise the service will fail.

 

StartDate

DateTime

 

 

The start date, the time cards that are to be retrieved must have an actual or planned work date after this date. The StartDate and EndDate define the period in which the time cards will be retrieved.

 

IncludeTaskHierarchyFlag

Boolean

 

 

If set to 'true', all the entire task hierarchy of the task associated with the time card(s) will be included

 

AutoMemorizeBookedAndAssignedRolesFlag

Boolean

 

 

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.

 

IncludeMemorizedRolesAndTasksFlag

Boolean

 

 

If set to 'true', memorized roles and tasks will be included in the response

 

RespectMemorizedRemovedRolesAndTasksFlag

Boolean

 

 

If set to 'true', roles and tasks that were removed from the timesheet will be excluded from the response

 

TimeCardIdentity

PwsTimecardRef

 

 

Identity of the time card, if request a single time card

 

  • No labels