List Project Offering Role Plans

Request

Lists paginated planned time entries for a Project Offering Role with filtering by date range. Days with no planned hours are not returned.

Security

ApiKey

Path

idstring, (uuid)required

ID of the resource

project_idstring, (uuid)required

project_offering_idstring, (uuid)required

Query

pageinteger, (int32)

The specific page of results requested.

page_sizeinteger, (int32)

The number of results in each page.

start_datestring, (date)

Filter by entries recorded on or after this date. ISO date formatting expected (yyyy-MM-dd)

end_datestring, (date)

Filter by entries recorded on or before this date. ISO date formatting expected (yyyy-MM-dd)

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time?page=0&page_size=0&start_date=2019-08-24&end_date=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

countinteger, (int64)

The number of results in the current page.

totalinteger, (int64)

The total number of results that fulfill the request.

pageinteger, (int64)

The current page of results being returned.

total_pagesinteger, (int64)

The total number of available pages that fulfill the request.

page_sizeinteger, (int64)

The number of results in each page returned.

resultsArray of objects(ProjectOfferingRolePlannedTime)required

The array of result objects for the current page.

Response

{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}