(BETA) Web API to the NCSU Scholarly Publications Repository
Overview
The Web API to the NCSU Scholarly Publications Repository (SPR) is designed to allow access to SPR citations and metadata in a machine readable format.
The goal is to facilitate the extension of the information in the SPR beyond the formats the SPR already provides.
To accomplish this goal the Web API utilizes the http request mechanism with specific cgi variables resulting in an xml formatted response.
This response can then be used by the requestor to display SPR data in whatever context they wish.
NOTE: Currently the Web API is in beta mode and the API as well as any information on this page may change as circumstances warrant.
GET Request Parameters
Parameter
Value
Description
service
Enumerated string (required)
Name of desired service. Currently only search is recognized.
type
Enumerated string (required if service is search)
Type of search being requested.
Possible values are author,affiliation,citation, systemid, and keyword.
author: query must be a numeric ID or set of numeric IDs that are comma delimited.
Results for this search include citation information and information on every NCSU author
associated with the citation.
affiliation: query must be a numeric ID or set of numeric IDs that are comma delimited.
Results for this search include citation information and information on only those NCSU authors
associated with the citation who are part of the submitted affiliation.
citation: query must be a numeric ID or set of numeric IDs that are comma delimited.
Results for this search include citation information and information on every NCSU author
associated with the citation.
systemid: query must be a numeric ID or set of numeric IDs that are comma delimited.
Results for this search include citation information but only include information on the NCSU author
associated with the system ID or IDs. Information on other NCSU authors associated with the
citation is not returned.
keyword: query can be words in author names, citation titles, or journal titles.
Results for this search include citation information and information on every NCSU author
associated with the citation.
See below for help in identifying specific IDs for authors and affiliations.
query
URL-encoded string (required)
Search term(s). Multiple IDs can be submitted if comma delimited.
If terms are not comma delimited than an inclusive AND is assumed.
limit
positive integer (optional), omit for a default of 100, use 0 for all results, any other number for upper limit.
Total number of citations to be returned by the request starting from the first citation.
year
Positive integer (optional), omit for all years.
Filter to limit citation results by year.
Multiple years can be submitted if comma delimited.
affiliation
Positive integer (optional), omit for all affiliations
Filter to limit citations and NCSU author information to those NCSU authors who belong to the submitted affiliation.
Multiple affiliations can be submitted if comma delimited. Using this filter with an affiliation type search
may produce no results unless both ids are the same which makes the filter meaningless.
captured
Date in YYYY-MM-DD format
Filter to limit citations and NCSU author information by the date the citation was entered into the SPR
(this is not the date of the citation itself, its a system data entry date). Only citations created or modified
in the SPR on and after the captured date are returned for the given search query.
output
Enumerated string (optional), omit for default "xml"
Defines the output format of the response. Currently only the base SPR xml is recognized but
future development will include rss and opensearch.
Affiliation IDs
Select an affiliation and its ID will be shown.
Use that numeric ID to refer to that affiliation for all searches to the web service.
Affiliation
ID
0
Example
Author and System IDs
Select the initial letter of the author's last name (or word in last name in some cases).
The author dropdown will change to all authors who have a word in their last name beginning with that letter.
Select the author your looking for to see their Author ID and System ID.
Use the relevant numeric ID to refer to that author for all author or systemid searches to the web service.
Note: Not all authors currently have system IDs. If you do not see a system ID when you select
the author, the system will not recognize a system id for that author.
