Help

About API

API, which can obtain policy information searchable in the SCPJ website in an XML format, is provided.

Information obtainable with API

Information obtainable with API consists of the following types. Each can obtain XML compatible with contents displayable in website pages.

  • Academic society search: corresponds to results of searches from the "Search by society name" box in the top page
  • Journal search: corresponds to results of searches from the "Search by journal title" box in the top page
  • Get detailed society information: corresponds to content of pages containing detailed information about each society
  • Get detailed journal information: corresponds to content of website pages containing detailed information about each journal

Ways to access API

While the website page showing the search results is open, suffix the URL with "?format=xml" parameter, and then the content displayed in the page will be returned in XML format. (It is REST format API whereby you specify the information you require with API as a URL, and then the XML text is returned as a response.) When Japanese is presented as a search keyword, URL encoding is needed for the parameter.

FunctionsExample of URL to obtain XML
Search by society name

Search results: http://scpj.tulips.tsukuba.ac.jp/search/society?keyword=%E6%83%85%E5%A0%B1

API: http://scpj.tulips.tsukuba.ac.jp/search/society?keyword=%E6%83%85%E5%A0%B1&format=xml

Search society by policy color

Search results: http://scpj.tulips.tsukuba.ac.jp/search/society/policy/Green

API: http://scpj.tulips.tsukuba.ac.jp/search/society/policy/Green?format=xml

Search by journal title

Search results: http://scpj.tulips.tsukuba.ac.jp/search/journal?keyword=%E6%83%85%E5%A0%B1

API: http://scpj.tulips.tsukuba.ac.jp/search/journal?keyword=%E6%83%85%E5%A0%B1&format=xml

Search journal by ISSN

Search results: http://scpj.tulips.tsukuba.ac.jp/search/journal?issn=03875008

API: http://scpj.tulips.tsukuba.ac.jp/search/journal?issn=03875008&format=xml

When searching for multiple ISSNs, separate them by commas when specifying them in the parameter. (e.g. issn=11112222,33334444)

Search journal by NCID

Search results: http://scpj.tulips.tsukuba.ac.jp/search/journal?ncid=AN00092640

API: http://scpj.tulips.tsukuba.ac.jp/search/journal?ncid=AN00092640&format=xml

When searching for multiple NCIDs, separate them by commas when specifying them in the parameter. (e.g. ncid=AN00092640,AA11615068)

Get detailed information by society ID

Search results: http://scpj.tulips.tsukuba.ac.jp/detail/society/id/S000005

API: http://scpj.tulips.tsukuba.ac.jp/detail/society/id/S000005?format=xml

Society IDs are specified as an "id" attribute in the <publisher> element when searching by society name, or in the <scpjpub> element when getting detailed information by journal ID or searching by journal title.

Get detailed information by journal ID

Search results: http://scpj.tulips.tsukuba.ac.jp/detail/journal/id/J000001

API: http://scpj.tulips.tsukuba.ac.jp/detail/journal/id/J000001?format=xml

Journal IDs are specified as an "id" attribute in the <journal> element when getting detailed information by society ID or searching by journal title.

Structure of returned XML

The structure of returned XML is based on XML returned by SHERPA/RoMRO API, and this XML deletes items for which there is no data in SCPJ and adds items lacking in the SHERPA/RoMEO format. Complying with SHERPA/RoMEO API as much as possible enables support of SCPJ, because only minor changes have to be made to programs written for SHERPA/RoMEO."

However, the structure of this XML differs in the following ways to SHERPA/ROMEO API.

  • *There are changes to the names of elements.
    • romeoapi → scpjapi
    • romeocolour → scpjcolour
    • romeopub → scpjpub
  • The following elements (and sub-elements), which do not exist in SCPJ, are deleted.
    • preprints
    • postprints
    • mandates
    • paidaccess
    • dateadded
  • Since SCPJ holds policy information for each journal, policy information is included even when getting detailed journal information. Specifically, policy information elements such as <scpjcolour> and <conditions> are included as a sub-element of the <journal< element. (They are not included when searching by journal title.)
  • Essentially, journals apply identical policies to those practiced by publishing societies, but some journals establish independent policies. In such a case, the policy="original" attribute is added to the <journal> element.
  • Since SCPJ holds the journal's alias and language data, <alias><languages> are added to the <journal> tag as sub-elements.
  • The "type" attribute, which describes the condition classification is added as a <condition> attribute. type="publishersversion" refers to usability of the publisher version, type="location" to publication location, and type="restrict" to publication restrictions.
  • In SCPJ, an ID is assigned to journals, so it is shown as the "id" attribute in the <journal> element. That ID can be used to get detailed information about the journal.
  • Publisher information stored in the <scpjpub> sub-element of the <journal> element enables you to find out what society published the journal. The "id" attribute is also specified in the <scpjpub> element, so detailed information about the society can be obtained with this ID.
  • The <comment> element, which shows comments about policies, is added.
  • In the case of SHERPA/RoMEO API, detailed information about the publishing journal is included when a journal search returns a single search result (outcome="singleJournal" format), but this is not included with SCPJ. Since journal information only is returned when searching for a journal, please access detailed society information API after confirming the publishing society's ID, even if it is just for a single case.
  • When detailed information about the society has been obtained, the synopsis issued by the society is included as the <journals> element.