Europe PMC Web Services Announcement (Version 6.7)

74 views
Skip to first unread message

Europe PMC Developer Forum

unread,
Nov 29, 2021, 6:42:11 AM11/29/21
to Europe PMC Developer Forum

Dear Europe PMC Webservice Users,

We would like to announce the release of version 6.7 of our web services, Soap and Rest.

Changes:

We have introduced a new Restful API for the Europe PMC articles API, which will allow users to input a list of publication IDs (PMID, PMCID, DOI, PPRID) and return status updates on these publications. This API helps identifying status updates on a large batch of publications. For example when an article is retracted, or when a preprint is published in a peer review journal. API url:

POST https://www.ebi.ac.uk/europepmc/webservices/rest/status-update

This module must be used with the header Content-type:application/json

All the parameters must be passed in the request body as a JSON object.

Construct your POST search requests as follows:

{

ids: [

           {

               src: string,

               extId: string

            }

         ]

 }

“src” can be (PMID, PMCID, DOI, PPR) where PPR is preprint type.

“extId” is the article id, either pubmed id, pmc id, preprtint or doi.

Request example:

POST https://www.ebi.ac.uk/europepmc/webservices/rest/status-update?format=xml

body:

{

"ids": [

   {

     "extId": "PPR404258",

      "src": "PPR"

   },

   {

     "extId": "PPR286317",

      "src": "PPR"

   },

   {

     "extId": "PPR178982",

     "src": "PPR"

   },

   {

    "extId": "34408887",

    "src": "MED"

   },

   {

     "extId": "PPR104949",

     "src": "PPR"

   },

   {

    "extId": "PPR104949",

     "src": "MED"

   }

 ]

}


Response example (xml):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><articleStatusSearchResponse xmlns:dcterms="http://purl.org/dc/terms/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:ns5="http://webservice.cdb.ebi.ac.uk/"><ns5:metrics><articlesFoundInTheDatabase>5</articlesFoundInTheDatabase><articlesNotFound><extId>PPR104949</extId><src>MED</src></articlesNotFound><articlesQueried>6</articlesQueried><articlesWithStatusUpdate>5</articlesWithStatusUpdate><articlesWithoutStatusUpdate>0</articlesWithoutStatusUpdate></ns5:metrics><ns5:articlesWithStatusUpdate><EXT_ID>PPR404258</EXT_ID><firstPublishDate>2021-09-30</firstPublishDate><links><href>https://europepmc.org/article/PPR/PPR404258</href><rel>SELF</rel></links><links><href>https://europepmc.org/article/MED/34494686</href><rel>PUBLISHED_ARTICLE</rel></links><SRC>PPR</SRC><title>Bayesian workflow for disease transmission modeling in Stan</title></ns5:articlesWithStatusUpdate><ns5:articlesWithStatusUpdate><EXT_ID>PPR286317</EXT_ID><firstPublishDate>2021-02-20</firstPublishDate><links><href>https://europepmc.org/article/PPR/PPR286317</href><rel>SELF</rel></links><links><href>https://europepmc.org/article/MED/34260078</href><rel>PUBLISHED_ARTICLE</rel></links><SRC>PPR</SRC><title>Evaluation of rapid antibody test and chest computed tomography results of COVID-19 patients: A retrospective study</title></ns5:articlesWithStatusUpdate><ns5:articlesWithStatusUpdate><EXT_ID>PPR178982</EXT_ID><firstPublishDate>2020-06-22</firstPublishDate><links><href>https://europepmc.org/article/PPR/PPR178982</href><rel>SELF</rel></links><SRC>PPR</SRC><title>Measles outbreak in a migrant laborer population in the wake of COVID-19 pandemic: Kathmandu, Nepal, 2020</title></ns5:articlesWithStatusUpdate><ns5:articlesWithStatusUpdate><EXT_ID>34408887</EXT_ID><firstPublishDate>2021-08-13</firstPublishDate><links><href>https://europepmc.org/article/MED/34408887</href><rel>SELF</rel></links><links><href>https://europepmc.org/article/MED/34603738</href><rel>RETRACTION_NOTICE_ARTICLE</rel></links><SRC>MED</SRC><title>A case report of Morvan syndrome.</title></ns5:articlesWithStatusUpdate><ns5:articlesWithStatusUpdate><EXT_ID>PPR104949</EXT_ID><firstPublishDate>2019-12-09</firstPublishDate><links><href>https://europepmc.org/article/PPR/PPR104949</href><rel>SELF</rel></links><links><href>https://europepmc.org/article/MED/33687234</href><rel>PUBLISHED_ARTICLE</rel></links><links><href>https://europepmc.org/article/PPR/PPR400439</href><rel>NEW_VERSION</rel></links><SRC>PPR</SRC><title>Quantum Interference in Real-Time Electron-Dynamics: Gaining Insights from Time-Dependent Configuration Interaction Simulations</title></ns5:articlesWithStatusUpdate></articleStatusSearchResponse>


Response example (json):

{"metrics":{"articlesQueried":6,"articlesFoundInTheDatabase":5,"articlesWithoutStatusUpdate":0,"articlesWithStatusUpdate":5,"articlesNotFound":[{"src":"MED","extId":"PPR104949"}]},"articlesWithStatusUpdate":[{"title":"Bayesian workflow for disease transmission modeling in Stan","firstPublishDate":"2021-09-30","statusUpdates":["PUBLISHED_VERSION_AVAILABLE"],"links":[{"href":"https://europepmc.org/article/PPR/PPR404258","rel":"SELF"},{"href":"https://europepmc.org/article/MED/34494686","rel":"PUBLISHED_ARTICLE"}],"src":"PPR","extId":"PPR404258"},{"title":"Evaluation of rapid antibody test and chest computed tomography results of COVID-19 patients: A retrospective study","firstPublishDate":"2021-02-20","statusUpdates":["PUBLISHED_VERSION_AVAILABLE","WITHDRAWN"],"links":[{"href":"https://europepmc.org/article/PPR/PPR286317","rel":"SELF"},{"href":"https://europepmc.org/article/MED/34260078","rel":"PUBLISHED_ARTICLE"}],"src":"PPR","extId":"PPR286317"},{"title":"Measles outbreak in a migrant laborer population in the wake of COVID-19 pandemic: Kathmandu, Nepal, 2020","firstPublishDate":"2020-06-22","statusUpdates":["REMOVED"],"links":[{"href":"https://europepmc.org/article/PPR/PPR178982","rel":"SELF"}],"src":"PPR","extId":"PPR178982"},{"title":"A case report of Morvan syndrome.","firstPublishDate":"2021-08-13","statusUpdates":["RETRACTED"],"links":[{"href":"https://europepmc.org/article/MED/34408887","rel":"SELF"},{"href":"https://europepmc.org/article/MED/34603738","rel":"RETRACTION_NOTICE_ARTICLE"}],"src":"MED","extId":"34408887"},{"title":"Quantum Interference in Real-Time Electron-Dynamics: Gaining Insights from Time-Dependent Configuration Interaction Simulations","firstPublishDate":"2019-12-09","statusUpdates":["PUBLISHED_VERSION_AVAILABLE","NEW_VERSION_AVAILABLE"],"links":[{"href":"https://europepmc.org/article/PPR/PPR104949","rel":"SELF"},{"href":"https://europepmc.org/article/MED/33687234","rel":"PUBLISHED_ARTICLE"},{"href":"https://europepmc.org/article/PPR/PPR400439","rel":"NEW_VERSION"}],"src":"PPR","extId":"PPR104949"}]}


format url parameter indicates response format, json is default.

This version is now available on migration server and production as well.

The only change in soap is incrementing version (6.7) for version consistency.

Test Rest URL: https://www.ebi.ac.uk/europepmc/webservices/test/rest

Live Rest URL: https://www.ebi.ac.uk/europepmc/webservices/rest

You can see an example also at our API documentation page on the website
https://europepmc.org/RestfulWebService#!/Europe32PMC32Articles32RESTful32API/statusUpdateSearch

Please let us know if you have any queries.

Europe PMC team


Reply all
Reply to author
Forward
0 new messages