PPMS API Doc
|
Final Reports
Returns a list of publicly-available projects with final reports. This returns only projects with status completed and final-report status published . The list can be filtered based on given keywords. This is a paged request. See Sending Request and Receiving Response for more information on paged requests and responses.
http://ppms-demo.cecs.pdx.edu/api/final_reports
Name |
Type |
Required |
Default |
Description |
keywords |
string |
No |
null |
If specified, only the projects that contain the given keywords will be returned. The search is done against the the project's title, abstract, and PI name. That is, if the keywords appear in any of these fields for a given project, that project is returned in the results. |
page_no |
string |
No |
1 |
The page number for which the results to be returned. The number of total possible results is returned in the response. |
num_of_results_per_page |
int |
No |
15 |
The maximum number of results to be returned per page. The maximum number that can be returned per page is 100. |
{
"final_reports": {
"results": [
{
"id": 3,
"title": "Addressing Bicycle-Vehicle ...",
"end_date": "2017-12-31",
"pi": "Sirisha Kothuri",
"pi_id": 2,
"project_outputs": [
{
"id": 3,
"title": "NITC-RR-897_Alternate_Signal ...",
"output_type": "final_report",
"url": "http://ppms-demo.cecs.pdx.edu/file/document/2b9de00c-9492-4e2c-8b2c-1dfdd103ccc4.pdf"
},
...
]
}
],
"total_results": 100,
"result_from": 1,
"result_to": 15
}
}
Field Name |
Type |
Description |
id |
int |
|
title |
string |
|
end_date |
string |
When the project ended. The Date is in the format YYYY-MM-DD. |
pi |
string |
The principal investigator listed for the project. |
pi_id |
int |
The id of the principal investigator listed for the project. |
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. |
project_outputs |
JSON[] |
A list of outputs that were produced by this project. This list will contain only outputs with type 'final_report' or 'project_brief' if available. |
project_outputs.id |
int |
|
project_outputs.title |
string |
|
project_outputs.output_type |
string |
The type of the output that was produced. Possible values are: 'final_report' or 'project_brief' |
project_outputs.url |
string |
The URL for the output. |
|