PPMS API Doc -> Project List

Returns a list of publicly-available projects. The list can be filtered based on certain parameters. See below for a full list of parameters. 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/project_list

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.
status	string	No	null	Possible values `'completed'` or `'in progress'`.
type	int	No	null	The type of the project(s). The value is the id returned by the Project Types end-point.
subject	int	No	null	The area of interest that the project(s) covers. The value is the id returned by the Subjects end-point.
funding_year	int	No	null	The start year of the grant cycle through which the project(s) is or was funded. The value is a year returned by the Funding Years end-point.
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.

            
{
  "project_list": {
    "results": [
      {
        "id": 2,
        "title": "Toward Automating the ...",
        "abstract_snippet": "Streets are one of the most ... ",
        "pi": "Seyed Hassan",
        "pi_id": 5,
        "status": "in progress",
        "completion_date": null
      }
      ...
    ],
    "total_results": 100,
    "result_from": 1,
    "result_to": 15
  }
}

Field Name	Type	Description
id	int
title	string
abstract_snippet	string
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.