PPMS API Doc
|
Project
Returns public information about a specific project. Note: only individuals that either have PI or Co-PI role are returned. Also, only outputs with the following project output types are returned: article , final_report , poster , publication , presentation , project_brief , website , other .
http://ppms-demo.cecs.pdx.edu/api/project
Name |
Type |
Required |
Default |
Description |
id |
int |
Yes |
|
The project id whose information to be returned. |
{
"project": [
{
"id": 3,
"title": "Addressing Bicycle-Vehicle ...",
"abstract": "There is nationwide interest in ...",
"start_date": "2015-08-01",
"end_date": "2017-12-31",
"research_type": "Research",
"status": "completed",
"completion_date": "2017-12-31",
"total_budget": 131384,
"grant_cycle": "Natl Round 2",
"project_photo": null,
"individuals": [
{
"id": 2,
"first_name": "Sirisha",
"last_name": "Kothuri",
"role": "pi"
},
...
],
"project_outputs": [
{
"id": 3,
"title": "NITC-RR-897_Alternate_Signal_Control_Strategies_Reduce_Conflict_accessible",
"output_type": "final_report",
"url": "http://ppms-demo.cecs.pdx.edu/file/document/2b9de00c-9492-4e2c-8b2c-1dfdd103ccc4.pdf"
},
...
]
}
]
}
Field Name |
Type |
Description |
id |
int |
The requested project id. |
title |
string |
|
abstract |
string |
|
start_date |
string |
When the project started. The Date is in the format YYYY-MM-DD. |
end_date |
string |
When the project ended. The Date is in the format YYYY-MM-DD. |
research_type |
string |
|
status |
string |
The status of the project. Possible values: 'completed' or 'in progress' . |
completion_date |
string |
If the project's status is 'completed' , this field contains the completion data. Otherwise, this field is null . The Date is in the format YYYY-MM-DD. |
total_budget |
float |
The total awarded funding amount to the project. |
grant_cycle |
string |
The grant cycle through which the project was funded. |
project_photo |
string |
The URL for the project photo if available. Otherwise, null . |
individuals |
JSON[] |
A list of individuals that are involved in this project. |
individuals.id |
int |
|
individuals.first_name |
string |
|
individuals.last_name |
string |
|
individuals.role |
string |
The role of the individual in this project. Possible values are: 'pi' or 'co-pi' . |
project_outputs |
JSON[] |
A list of outputs that were produced by this project, if any. |
project_outputs.id |
int |
|
project_outputs.title |
string |
|
project_outputs.output_type |
string |
The type of the output that was produced. Possible values are: article , final_report , poster , publication , presentation , project_brief , website , other . |
project_outputs.url |
string |
The URL for the output. |
|