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	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AdW9hL5iEq/mAQnDQ5AweA==
EndDate	DateTime	Yes		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.	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 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 associated with a project will be included in the response	true
IncludeTimeOffCardsFlag	Boolean	No	false	If set to 'true, time off cards associated with a time off reason will be included in the response	false
ProjectIdentity	PwsProjectRef	No		Identity of project, if requesting time cards for a single project
ResourceIdentity	PwsResourceRef	No		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	Yes		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.	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.	false
IncludeMemorizedRolesAndTasksFlag	Boolean	No	false	If set to 'true', memorized roles and tasks will be included in the response	false
RespectMemorizedRemovedRolesAndTasksFlag	Boolean	No	false	If set to 'true', roles and tasks that were removed from the timesheet will be excluded from the response	false
TimeCardIdentity	PwsTimecardRef	No		Identity of the time card, if request a single time card

Request Usage Example(s)

Example 01

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetTimeCards>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdW9hL5iEq/mAQnDQ5AweA==</req:SessionTicket>
            <tim:EndDate>2018-12-31T00:00:00.000Z</tim:EndDate>
            <tim:IncludeApprovedFlag>false</tim:IncludeApprovedFlag>
            <tim:IncludeBookedAndAssignedRolesFlag>true</tim:IncludeBookedAndAssignedRolesFlag>
            <tim:IncludeDraftFlag>true</tim:IncludeDraftFlag>
            <tim:IncludeReferencedTasksOnlyFlag>true</tim:IncludeReferencedTasksOnlyFlag>
            <tim:IncludeReferencedTimeOffReasonsOnlyFlag>true</tim:IncludeReferencedTimeOffReasonsOnlyFlag>
            <tim:IncludeRejectedFlag>false</tim:IncludeRejectedFlag>
            <tim:IncludeSubmittedFlag>true</tim:IncludeSubmittedFlag>
            <tim:IncludeTimeCardsFlag>true</tim:IncludeTimeCardsFlag>
            <tim:IncludeTimeOffCardsFlag>true</tim:IncludeTimeOffCardsFlag>
            <tim:ProjectIdentity>
               <com:ProjectCode>P001395-001</com:ProjectCode>
            </tim:ProjectIdentity>
            <tim:StartDate>2018-01-01T00:00:00.000Z</tim:StartDate>
            <tim:IncludeTaskHierarchyFlag>false</tim:IncludeTaskHierarchyFlag>
            <tim:AutoMemorizeBookedAndAssignedRolesFlag>false</tim:AutoMemorizeBookedAndAssignedRolesFlag>
            <tim:IncludeMemorizedRolesAndTasksFlag>false</tim:IncludeMemorizedRolesAndTasksFlag>
            <tim:RespectMemorizedRemovedRolesAndTasksFlag>false</tim:RespectMemorizedRemovedRolesAndTasksFlag>
         </pws:serviceRequest>
      </pws:PwsGetTimeCards>
   </soapenv:Body>
</soapenv:Envelope>