Skip to end of metadata
Go to start of metadata

Introduction

The THECB Reports API was created for the purpose of collecting the data fro 18 Characteristics of Texas Public Doctoral Programs. Any client with HTTP protocol support can talk to this API to pull data as needed. The results returned are from UTA Profile System

Usage

End-Point (URI): 

http://www.uta.edu/ra/real/publications/thecbreports-api.php

The API will look at Accept header field of the request to determine the Content-Type of the response as well as the format of data included in the body. Currently, there are 2 formats supported corresponding to the Accept values: application/json and text/xml.

Supported Parameters

  • userId – String (optional) : filter the results by 1000 number of the faculty
  • userIds – String (optional) : filter the results by 1000 numbers of the faculty
    • Either userId or userIds is required
    • year – Integer (required):  filter the results by year
    • callback – String (optional): the callback used to wrap the results. This will be useful for pulling data with JSONP.

Results

The result returned as a HTTP package with status code indicating the result of request.

  • Status Code:
    • 200 – Success
    • 400 - Bad Request or Internal Server Error. The bad request arises when :
      • Both the userId and the userIds are not provided in the request.
      • year is not provided
      • userIds is not a list of userId

In case of Success (Status Code is 200), the body of the HTTP package contains the list of rows. Each row includes the following fields:

  • pid – Integer: the profile id of the faculty. This id can be used to form the absolute URL to access faculty profile. For instance, if pid is 119, the absolute URL to access faculty profile is http://www.uta.edu/ra/real/editprofile.php?pid=119
  • userId – String: the 1000 number of the faculty
  • refereed - Integer: the number of published publications that do not fall into the categories of Books, Book Chapters, and Discoveries/Patents.
  • books -- Integer: the number of published publications of the types “Book” and “Textbook”.
  • bookChapters -- Integer: the number of published publications of the type “Book Chapter”
  • patents -- Integer: the number of published publications of the type “Patent”
  • totalReported -- Integer: the total number of published Publications. It’s the sum of refereed, books, bookChapters and patents.
  • nonRefereed - Integer: the number of published publications that are not refereed and do not fall into the categories Books, Book Chapters, or Patents.
  • nonPublished -- Integer: the number of publications that are not published.
  • totalNonReported -- Integer: the total number of ignored/unreported publications. It’s the sum of nonRefereed and nonPublished.
  • lastLogin -- Integer: the most recent login UNIX timestamp of the faculty
  • lastUpdate -- Integer: the UNIX timestamp of the most recent update done on any publications of the faculty.
  • presentations -- Integer: counts entries from the Presentations and Projects section. Important: this number is approximately determined because the data entered by faculty is not well-structured

Examples:

Invalid request because of not providing the required parameter, userId or userIds, in the request: 

Request:

GET http://www.uta.edu/ra/real/publications/thecbreports-api.php

Response: (Status code: 400)


Invalid request because of not providing the required parameter, year, in the request: 

Request: 

GET http://www.uta.edu/ra/real/publications/thecbreports-api.php?userId=1000560856

Response: (Status code: 400)

Request the statistics of the faculty with userId 1000560856 for the year 2011, expecting results in XML

Request:

GET http://www.uta.edu/ra/real/publications/thecbreports-api.php?userId=1000560856&year=2011
Accept: text/xml

Response: (Status code: 200)

Request the statistics of the faculty with userId 1000560856 for the year 2011, expecting results in JSON

Request:

GET http://www.uta.edu/ra/real/publications/thecbreports-api.php?userId=1000560856&year=2011
Accept: application/json

Response: (Status code: 200)

Request the statistics of the faculty with userId 1000560856 and 1000422425 for the year 2011, expecting results in JSON

Request:

GET http://www.uta.edu/ra/real/publications/thecbreports-api.php?userIds[]=1000560856&userIds[]=1000422425&year=2011
Accept: application/json

Response: (Status code: 200)

Request the statistics of the faculty with userId 1000560856 and 1000422425 for the year 2011, expecting results in JSON and support callback (for cross domain fetching in Javascript)

Request:

GET http://www.uta.edu/ra/real/publications/thecbreports-api.php?userIds[]=1000560856&userIds[]=1000422425&year=2011&callback=processResults
Accept: application/json

Response: (Status code: 200)

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.