nitrc:NITRC Remote Data Access
From NITRC Wiki
Users have the ability to pull data from NITRC to their own sites by calling an appropriate script. The data is returned in JSON format, with an array of objects with name:value pairs. (For more information or help with JSON format, please refer to http://json.org/.)
Full Attribute List
The full attribute list can be downloaded in JSON format from http://www.nitrc.org/export/site/attributes.json.php.
Attribute Object
| Name | Data Type | Description |
|---|---|---|
| id | integer | the unique identifier for this attribute |
| parent | integer | the unique identifier of the parent attribute (0 if this is a top-level attribute) |
| shortname | string | the short code for this attribute |
| fullname | string | the full name of this attribute |
| description | string | the description of this attribute |
Tools and Resources
Public data from NITRC tools/resources can be downloaded in JSON format from http://www.nitrc.org/export/site/projects.json.php.
For this script, there are three classes of tool/resource on NITRC:
- locally hosted on NITRC and of interest to the INCF (software)
- locally hosted on NITRC but not of interest to the INCF (such as hardware or software that is also listed locally on the INCF site)
- locally hosted on the INCF site and imported to NITRC
You may download data from these classes or from a specific tool/resource with a "spec" variable:
- projects.json.php?spec=all - returns all tools/resources on NITRC (classes 1, 2, and 3)
- projects.json.php?spec=local - returns tools/resources hosted locally (classes 1 and 2)
- projects.json.php?spec=incf - returns tools/resources of interest to the INCF (class 1)
- projects.json.php - returns tools/resources of interest to the INCF (class 1)
- projects.json.php?spec=<id> - returns a single tool/resource
Overall Object
| Name | Data Type | Description |
|---|---|---|
| review_questions | object | an array of review question objects |
| projects | object | an array of tool/resource objects |
- Review Question Object
Name Data Type Description id integer the unique identifier for this question type integer a code giving the type of question (1 = Rating Buttons 1-5)
(2 = Text Area)
(3 = Radio Buttons Yes/No)
(4 = Comment Only)
(5 = Text Field)
(6 = Select List 1-5)
(100 = None)question string the review question question_short string a short version of the review question question_mid string a mid-length version of the review question
- Tool/Resource Object
Name Data Type Description id integer the unique identifier for this tool/resource name string the name of this tool/resource homepage string the summary page or other home page URL for this tool/resource unix_name string the short name used by the NITRC system for this tool/resource description string the public description shown on the tool/resource summary page register_datetime integer the timestamp when the tool/resource was registered on NITRC review_url string the URL at which the user reviews for this tool/resource can be found news_rss_url string the URL at which the news RSS feed for this tool/resource can be found screenshots object array of screenshot objects attributes object array of attribute objects users object array of user objects document_groups object array of document group objects packages object array of package objects reviews object array of review objects source string 'NITRC' or 'INCF'
- Screenshot Object
Name Data Type Description id integer the unique identifier for this screenshot/image name string the file name of this image description string the description/title of this image url string a URL pointing to the image itself is_default boolean if true, the image is displayed on the tool/resource summary page
- Attribute Object
Name Data Type Description id integer the unique identifier for this attribute fullname string the name of this attribute
- User Object
Name Data Type Description role string the role assigned to this user (Admin, Senior Developer, Junior Developer, Doc Writer, Support Tech, or other role created by the tool/resource administrator) id integer the unique identifier for this user user_name string NITRC login name for this user firstname string the user's first name lastname string the user's last name email string the user's e-mail address
- Document Group Object
Name Data Type Description id integer the unique identifier for this document group/folder name string the name of this document group/folder subgroups object array of document group objects documents object array of document objects
- Document Object
Name Data Type Description id integer the unique identifier for this document title string the title of the document description string the description of the document create_date integer the timestamp when the document was uploaded to NITRC update_date integer the timestamp when the document was updated in NITRC; 0 if not updated url string a URL pointing to the document file
- Package Object
Name Data Type Description id integer the unique identifier for this package name string the name of this package releases object array of release objects
- Release Object
Name Data Type Description id integer the unique identifier for this release name string the name of this release notes string the release notes changes string the change log preformatted_flag boolean if true, ASCII-style text should be preserved in release notes and change log release_date integer the timestamp for the release date files object array of file objects
- File Object
Name Data Type Description id integer the unique identifier for the file name string the name of the file type string the type of file (for example, .jpg, text, or URL) processor string the processor need for the file download_count integer the total number of times the file has been downloaded through NITRC size integer the size of the file in bytes url string a URL pointing to the released file
- Review Object
Name Data Type Description post_date integer the timestamp when the review was posted in NITRC responses object array of response objects
- Response Object
Name Data Type Description id integer the unique identifier for the question from the review question object response string the response given by the reviewer for the question
