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

« Previous Version 17 Next »

Request

Details are returned for all time cards that meet all of the criteria specified. The service request contains:

Name

Data Type

Required?

Default Value

Discussion

ResourceFilteringFlag

boolean

no

False

If 0, filter based upon engagement cost center, if 1 filter based upon resource cost center

CostCenterReferenceSystemId

string(40)

no

 

Reference system id (cost center number) of cost center to filter by

BillableOnlyFlag

boolean

no

false

True to include billable time cards only

IncludeTimeOffFlag

boolean

no

false

True to include time off

IncludeTimecardFlag

boolean

no

true

True to include time cards

IncludeUnapprovedFlag

boolean

no

false

True to include unapproved time

IncludeTempWorkersFlag

boolean

no

true

True to include time cards for temporary workers

MaxRowsToReturn

int

no

1000

Maximum number of data rows to return

Bookmark64

string

no

 

Bookmark (represents the last data previously exported by this web service – a new bookmark value will be returned)


Response

If the invoice exists, then the following data is returned:

Name

Data Type

Discussion

ExportIncrementalTimeFeed

list of ExportIncrementalTimeFeedRecord

One record per time card/time off card

RowCount

int

Number of rows returned

Bookmark64

string

New bookmark value (should be passed to next call of same service to ensure continuity)



The ExportIncrementalTimeFeedRecord record consists of:

Name

Data Type

Discussion

ResourceReferenceSystemId

string(20)

Resource employee id

ResourceDisplayName

string(30)

Resource display name

ResourceLocationName

string(50)

Resource's location

ResourceCostCenterReferenceSystemID

string(40)

Reference system id (cost center number) of resource cost center

ResourceCompanyReferenceSystemID

string(20)

Reference system id of resource cost center's company

ProjectCode

string(24)

Project code

ProjectTaskCodeName

string(50)

Deprecated. Returns the same as ProjectTaskTypeName

ProjectTaskTypeName

string(50)

Task type name

ProjectRateTypeName

string(50)

Rate type name

EngagementCostCenterReferenceSystemID

string(40)

Reference system id (cost center number) of engagement cost center

EngagementCompanyReferenceSystemID

string(40)

Reference system id for engagement cost center's company

EngagementTypeBillableFlag

boolean

Engagement type billable flag

EngagementTypeShortName

string(15)

Engagement type short name

TimeOffReasonName

string(50)

Time off reason name

WorkOrTimeoffDate

datetime

Work date for time cards or time off date for time off

WorkOrTimeoffMinutes

int

Work minutes for time cards, or time off minutes for time off

TimecardNonbillableFlag

boolean

Deprecated. Always returns false.

TimecardLocationName

string(50)

Name of location associated with time card, if any

TimecardOrTimeoffUid

long

Unique identifier for time card or time off card



Notes:

  • Time cards can be distinguished from time off cards in the output by presence of a non-null ProjectCode (ProjectCode will be null for time off cards).
  • The Bookmark64 input/output is intended to keep track of a point in time such that a sequence of calls to this service will provide a continuous stream of data with no gaps or overlaps. With each call to this service, you should pass the value returned by the prior call, passing null with the very first call. It is your responsibility to store this bookmark value for future use.
  • If you wish to start with data as of a specific point in time, Projector can provide you with a starting value for Bookmark64.
  • Once you have established the input parameters, put your program into operation, and have a valid bookmark tracking the data that has been extracted thus far, altering the parameters your supply to this service on subsequent calls using the same bookmark sequence will yield possibly unpredictable and incorrect results. Do this with great care.

Changelog

4.4

Parameter

Notes

ProjectTaskTypeName

Added as a parameter of ExportIncrementalTimeFeedRecord

ProjectRateTypeName

Added as a parameter of ExportIncrementalTimeFeedRecord

ExportIncrementalTimeFeedRecord.TimecardNonbillableFlag

Deprecated. Always returns false.

  • No labels