ExportBookings

Use the response from ExportRoles to determine the resource information associated with each role on each project.

Request

The service request contains:

Name

Data Type

Required?

Default Value

Discussion

BillableOnlyFlag

boolean

no

false

Set to true to limit the export to billable projects.

MaxRowsToReturn

int

no

1000

The maximum number of cards to be exported. Values greater than 1000 may fail due to system-enforced transaction time limits.

ProjectCodesAfter

string(24)

no

 

Export is limited to bookings whose project code comes after this project code. To avoid skipping or duplicating exported items set this to the last ProjectCode from the previous result set.

RoleNamesAfter

string(32)

no

 

Export is limited to bookings whose role name comes after this role name. To avoid skipping or duplicating exported items set this to the last RoleName from the previous result set.

PeriodStartDatesAfter

date

no

 

Export is limited to bookings whose period start date comes after this period start date. To avoid skipping or duplicating exported items set this to the last PeriodStartDate from the previous result set.

OnlyCountRows

boolean

no

false

If true, then only the RowCount is returned.


Response


For each project in the result set the following data is returned:

Name

Data Type

Discussion

ProjectCode

string

 

RoleName

string

 

PeriodStartDate

date

 

TimeScaleUnit

string

'D' for Daily, 'W' for Weekly

BookedMinutes1

int

For daily bookings, this is the booked minutes for day 1 of the week. For weekly bookings, this is the total booked minutes for the week.

BookedMinutes2

int

For daily bookings, this is the booked minutes for day 2. Undefined for weekly bookings.

BookedMinutes3

int

For daily bookings, this is the booked minutes for day 3. Undefined for weekly bookings.

BookedMinutes4

int

For daily bookings, this is the booked minutes for day 4. Undefined for weekly bookings.

BookedMinutes5

int

For daily bookings, this is the booked minutes for day 5. Undefined for weekly bookings.

BookedMinutes6

int

For daily bookings, this is the booked minutes for day 6. Undefined for weekly bookings.

BookedMinutes7

int

For daily bookings, this is the booked minutes for day 7. Undefined for weekly bookings.

BookedMinutesPeriod

int

The total minutes booked for the week.


Notes:

  • BookedMinutes1 through BookedMinutes7, in the case of daily bookings, hold the minutes booked for day 1 through day 7 of the week, where day 1 depends upon the configured first day of week for your account.