ExportRoles

Use this web service to export the roles on all of the selected projects. Combined with ExportBookings, it is possible to obtain a complete view of who is assigned to which roles in each time period.

Request

The service request contains:

Name

Data Type

Required?

Default Value

Discussion

LimitToOpenForTimeFlag

boolean

no

false

Set to true to limit the export to projects open for time.

LimitToOpenForCostFlag

boolean

no

false

Set to true to limit the export to projects open for cost.

EngagementType

string(15)

no

 

If supplied then the export is limited to projects with this engagement type.

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 roles 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 roles 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.

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

 

DisplayName

string

 

EmployeeId

string

This is the resource's reference system ID.

CostCenterName

string

Resource cost center

LocationName

string

Resource location

DepartmentName

string

Resource department

TitleName

string

Resource title

BaseRatesOnTitleName

string

The title on which the rates are based