Assignment History

The Assignment History report allows you to fetch records of all the assignments that exist for a specific Project or Person. Each entity type has a respective endpoint below.

Get Project's Assignment History Data

GET - /v2/companies/<company_id>/projects/<project_id>/reports/assignment-history

Get Person's Assignment History Data

GET - /v2/companies/<company_id>/people/<person_id>/reports/assignment-history

Optional Params for Project request only

PropertyData TypeDescription
employeeNameBooleanWill return the Person's name for each assignment

Default: true
employeeNumberBooleanWill return the Person's number for each assignment

Default: true
jobTitleBooleanWill return the Person's Job Title for each assignment

Default: true

Optional Params for Person request only

PropertyData TypeDescription
projectNameBooleanWill return the Project name for each assignment

Default: true
projectNumberBooleanWill return the Project number for each assignment

Default: true

Optional Params for both Project and Person request

PropertyData TypeDescription
assignmentStartBooleanWill return the start date for each assignment

Default: true
assignmentEndBooleanWill return the end date for each assignment

Default: true
startTimeBooleanWill return the daily start time for each assignment

Default: true
endTimeBooleanWill return the daily end time for each assignment

Default: true
costCodeBooleanWill return the name and UUID of the Cost Code for each assignment.

Default: true
labelsBooleanWill return the name and UUID of the Label for each assignment.

Default: true
durationBooleanWill return a calculated duration for each listed assignment. Values will be formatted as below. It should also be noted that duration is calculated on calendar weeks, not work weeks.

3D = 3 Days
1W 2D = 9 Days
2W = 14 days

Default: true

Responses:

Successful Response

The returned JSON array will contain objects representing each assignment that will have some permutation of the below properties depending on what your request param configuration is.

[
  {
    // Project Request Only
    "person_name": {"first": "Joseph", "last": "Lopez" },
    "employee_number": "123-a234s-456",
    "job_title": "Journeyman",
    
    // Person Request Only
    "project_name": "Hospital Job",
    "project_number": "123abc",
    
    // Both Request
    "start_day": "10/01/2017",
    "end_day": "11/02/2017",
    "start_time": "7:30 am",
    "end_time": "3:30 pm",
    "cost_code_name": "Phase 1",
    "code_code_id": "e70d45dd-27dc-43ad-ab1a-abd4c54bbe3a",
    "label_name": "Temp Work",
    "label_id": "25202254-f832-403f-9a96-2df2ceb8faf1",
    "duration": "4W 5D"
  },
  ...
]