Projects

This group refers to endpoints related to projects.

Get Student Proposal Progress for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/proposal/students

This endpoint retrieves information about Year Group students PBL details for Proposal component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/proposal/students

Get Student Reflection Progress for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/reflections/students

This endpoint retrieves information about Year Group students PBL details for Reflections component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/reflections/students

Get Student Personal Todos and Deadlines for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/todos/students

This endpoint retrieves information about Year Group students PBL details for Todos component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/todos/students

Get Student Journal Entries for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/journal/students

This endpoint retrieves information about Year Group students PBL details for Journal component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/journal/students

Get Student Documents for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/documents/students

This endpoint retrieves information about Year Group students PBL details for Documents component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/documents/students

Get Student Presentations for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/presentation/students

This endpoint retrieves information about Year Group students PBL details for Presentation component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/presentation/students

Get Student Notes & Interviews for a Year Group PBL

get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/notes_and_interviews/students

This endpoint retrieves information about Year Group students PBL details for Notes and Interviews component.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
year_group_idintegerRequired

A Year Group ID.

project_idintegerRequired

A PBL Project ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

include_archived_studentsbooleanOptional

A boolean parameter to specify that specifies if archived students are included in response

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{year_group_id}/projects/pbl/{project_id}/notes_and_interviews/students

Get all Year Group Project Based Learning

get
/v2p1/year-groups/{id}/projects/pbl

This endpoint retrieves information about Year Group PBL details.

Authorizations
auth_tokenstringRequired

Your V2 API authentication token may be passed in the parameters. To protect your key, use environment variables.

Path parameters
idintegerRequired

A Year Group ID.

Query parameters
archivedbooleanOptional

A boolean parameter to filter archived or active Year Groups

Responses
chevron-right
200

Success

application/json
get
/v2p1/year-groups/{id}/projects/pbl
200

Success

Last updated

Was this helpful?