Europe PMC Web Services Announcement (Version 6.6)

137 views
Skip to first unread message

Europe PMC Developer Forum

unread,
Aug 4, 2021, 7:30:35 AM8/4/21
to Europe PMC Developer Forum
Dear Europe PMC Webservice Users,
We would like to announce the release of version 6.6 of our web services, Soap and Rest.
Changes:
1. This new version introduces one new field "<nextPageUrl>", in the GET search endpoint of our REST application. This field displays the URL which allows the user to navigate to the next page of results while taking into consideration the original query parameters.
The updated REST search response will now have the new <nextPageUrl> field along with existing <nextCursorMark>. See example below.
<version>6.6</version>
<hitCount>205514</hitCount>
<nextCursorMark>AoIIQKfYxyg0NDIyNjA1Nw==</nextCursorMark>
<nextPageUrl>https://www.ebi.ac.uk/europepmc/webservices/test/rest/search?query=malaria&cursorMark=AoIIQKfYxyg0NDIyNjA1Nw==&resultType=core&format=xml</nextPageUrl>

If nextPageUrl or nextCursorMark are absent from response, this means that end of results is reached and no additional api call are needed.

2. REST APIs can return data in a number of formats, through a process called content negotiation. The formats used in Europe PMC are application/json (json), application/xml (xml), application/dc (dc). Currently, we use only the format parameter to allow the client to specify the format of the response, e.g. https://www.ebi.ac.uk/europepmc/webservices/test/rest/search?query=ext_id:28620943&format=jsonIn the new version, we support both Accept header and the format parameter and give priority to the parameter format if it is there. If the format parameter is not provided, we take the value of the Accept header. If none is provided, we display the response in XML format.

3. <pubType> information is now included inside the <version> element of the core response.
Example of the new version list object:
<versionList>
  <version>
    <id>PPR170401</id>
    <source>PPR</source>
    <firstPublishDate>2020-06-02</firstPublishDate>
    <versionNumber>1</versionNumber>
    <pubTypeList>
      <pubType>preprint</pubType>
    </pubTypeList>
  </version>
  <version>
    <id>PPR230365</id>
    <source>PPR</source>
    <firstPublishDate>2020-10-26</firstPublishDate>
    <versionNumber>2</versionNumber>
    <pubTypeList>
      <pubType>preprint</pubType>
      <pubType>preprint-withdrawal</pubType>
    </pubTypeList>
   </version>
</versionList>
Change number 3 has been implemented for a preprint record, whether a different version of the same preprint has either pubType="preprint-withdrawal" or "preprint-removal".
To avoid additional API calls, pubType information has now been included in the <version> element of the core response.This version is now available on migration server
Rest: https://www.ebi.ac.uk/europepmc/webservices/test/rest
Soap: https://www.ebi.ac.uk/europepmc/webservices/test/soap?wsdl
We plan to move this version to production on 17th of August. Closer to this date, we will send you another message to confirm the schedule.
Please let us know if you have any queries.
Europe PMC team

Mohamed Selim

unread,
Aug 18, 2021, 6:37:01 AM8/18/21
to Europe PMC Developer Forum, Europe PMC Developer Forum
Dear Europe PMC Webservice Users,
This version has been released to production.
Thank you,
Europe PMC team

Najko Jahn

unread,
Aug 20, 2021, 6:18:39 AM8/20/21
to Europe PMC Developer Forum, Europe PMC Developer Forum
Dear Europe PMC team,

It seems that nextCursorMark is now completely absent from API calls, only nextPageUrl is exposed. 

Bildschirmfoto 2021-08-20 um 12.05.26.png
Thanks for fixing!

Najko Jahn

Mohamed Selim

unread,
Aug 20, 2021, 6:31:03 AM8/20/21
to Europe PMC Developer Forum, najko...@gmail.com, Europe PMC Developer Forum
Hi Najko,
There was a bug that we fixed today, could you please try again?

Reply all
Reply to author
Forward
0 new messages