CINXE.COM

Journal Checker Tool: Check which publishing options are supported by your funder’s OA policy | Public API docs

<!DOCTYPE html> <html class="no-js" lang="en"><head> <meta charset="utf-8"> <title>Journal Checker Tool: Check which publishing options are supported by your funder’s OA policy | Public API docs</title> <meta name="description" content="Documentation of the public API for the Journal Checker Tool: Plan S Compliance Validator."> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="theme-color" content="#282624"> <link rel="apple-touch-icon" href="icon.png"> <link href="https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300;0,400;0,600;0,700;0,800;1,300;1,400;1,600;1,700;1,800&display=swap" rel="stylesheet"> <link href="/css/main.css?v=5.5.4" rel='stylesheet' type='text/css'> <script type="text/javascript" src="/js/api_endpoint.js?v=5.5.4"></script> <script type="text/javascript" src="/js/modals.js?v=5.5.4"></script> <script type="text/javascript" src="/js/jct.js?v=5.5.4"></script> <script type="text/javascript" src="/js/feedback.js?v=5.5.4"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-189315404-2"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-189315404-2'); </script> </head> <body><header> <div class="header-logo"> <h2 class="label"><svg width="13" height="20" viewbox="0 0 13 20" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M6.28479 2.14158C5.43898 2.14158 4.62781 2.47934 4.02973 3.08057C3.43165 3.6818 3.09564 4.49725 3.09564 5.34752V6.07785H0.965235V5.34752C0.965235 3.92928 1.52568 2.56912 2.52329 1.56626C3.5209 0.563403 4.87395 0 6.28479 0C7.69562 0 9.04868 0.563403 10.0463 1.56626C11.0439 2.56912 11.6043 3.92928 11.6043 5.34752V10.3707C12.2009 11.3357 12.5455 12.4746 12.5455 13.6944C12.5455 17.1769 9.73706 20 6.27273 20C2.8084 20 0 17.1769 0 13.6944C0 10.2119 2.8084 7.38877 6.27273 7.38877C7.44213 7.38877 8.5368 7.71045 9.47393 8.27058V5.34752C9.47393 4.49725 9.13793 3.6818 8.53984 3.08057C7.94176 2.47934 7.13059 2.14158 6.28479 2.14158ZM6.27273 9.53034C3.98499 9.53034 2.13041 11.3946 2.13041 13.6944C2.13041 15.9941 3.98499 17.8584 6.27273 17.8584C8.56047 17.8584 10.415 15.9941 10.415 13.6944C10.415 11.3946 8.56047 9.53034 6.27273 9.53034Z" fill="#F47115"></path> <path d="M6.29321 15.4802C7.26388 15.4802 8.05077 14.6892 8.05077 13.7134C8.05077 12.7376 7.26388 11.9466 6.29321 11.9466C5.32254 11.9466 4.53566 12.7376 4.53566 13.7134C4.53566 14.6892 5.32254 15.4802 6.29321 15.4802Z" fill="#F47115"></path> </svg><a href="/">Journal Checker Tool</a> </h2> </div> </header> <main class="container"> <div class="row row--centered"> <div class="col col--1of2"> <style type="text/css"> table { border: 1px solid #cccccc; } thead { font-weight: bold; } td, th { border: 1px solid #cccccc; padding: 5px; } </style> <h1 id="jct-public-api">JCT Public API</h1> <p>The api is available at <a href="https://api.journalcheckertool.org/">https://api.journalcheckertool.org/</a>.</p> <h2 id="request-a-compliance-calculation">Request a compliance calculation</h2> <p>To carry out a compliance calculation, you can make an HTTP GET request, as detailed below.</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">GET /calculate?issn<span style="color:#f92672">=[</span>issn<span style="color:#f92672">]</span>&amp;funder<span style="color:#f92672">=[</span>funder<span style="color:#f92672">]</span>&amp;ror<span style="color:#f92672">=[</span>ror<span style="color:#f92672">]</span> </code></pre></div><p>The server will execute the algorithm, and gather responses for all routes before responding to the request.</p> <p>The parameters you can pass to the <code>/calculate</code> endpoint are as follows:</p> <ul> <li><strong>issn</strong> - either the print or online ISSN of the journal you wish to check. <em>required</em></li> <li><strong>funder</strong> - the JCT ID for the funder that you wish to check. Allowable Funder IDs are listed <a href="/funder-ids">here</a>. <em>required</em></li> <li><strong>ror</strong> - the ROR ID of the organisation that you wish to check. See <a href="https://ror.org/">https://ror.org</a> for more information. <em>optional</em></li> </ul> <p>The <code>issn</code> field is the only <em>required</em> field, though without the <code>ror</code> and <code>funder</code> fields your results will be partial, and may not give you complete and accurate information.</p> <p>If you enter an invalid <code>funder</code>, the API will respond with a <code>400 (Bad Request)</code></p> <p>The <code>ror</code> field is optional, and is equivalent to selecting &ldquo;Not affiliated&rdquo; via the User Interface.</p> <p>Examples:</p> <ul> <li>PLoS One, Wellcome Trust, University of Oxford: <a href="https://api.journalcheckertool.org/calculate?issn=1932-6203&amp;funder=wellcome&amp;ror=052gg0110">https://api.journalcheckertool.org/calculate?issn=1932-6203&amp;funder=wellcome&amp;ror=052gg0110</a>.</li> <li>Nature Medicine, Academy of Finland, no institution: <a href="https://api.journalcheckertool.org/calculate?issn=1078-8956&amp;funder=academyoffinlandaka&amp;not_he=true">https://api.journalcheckertool.org/calculate?issn=1078-8956&amp;funder=academyoffinlandaka&amp;not_he=true</a></li> </ul> <h3 id="overall-response-format">Overall response format</h3> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{ <span style="color:#f92672">&#34;request&#34;</span> : { <span style="color:#f92672">&#34;started&#34;</span> : <span style="color:#e6db74">&#34;&lt;(int) start timestamp of the request&gt;&#34;</span>, <span style="color:#f92672">&#34;ended&#34;</span> : <span style="color:#e6db74">&#34;&lt;(int) end timestamp of the request&gt;&#34;</span>, <span style="color:#f92672">&#34;took&#34;</span> : <span style="color:#e6db74">&#34;&lt;(int) the time in ms between request start and end (on the server, not including travel time)&gt;&#34;</span>, <span style="color:#f92672">&#34;journal&#34;</span> : [ { <span style="color:#f92672">&#34;id&#34;</span>: <span style="color:#e6db74">&#34;&lt;journal issn&gt;&#34;</span>, <span style="color:#f92672">&#34;title&#34;</span>: <span style="color:#e6db74">&#34;&lt;journal title&gt;&#34;</span>, <span style="color:#f92672">&#34;issn&#34;</span> : [<span style="color:#e6db74">&#34;&lt;all of the matching ISSNs for this journal&gt;&#34;</span>], <span style="color:#f92672">&#34;publisher&#34;</span> : <span style="color:#e6db74">&#34;&lt;journal publisher&gt;&#34;</span>, <span style="color:#f92672">&#34;price_data_years&#34;</span> : [<span style="color:#e6db74">&#34;&lt;int:years for which price data has been uploaded to JCS&gt;&#34;</span>] } ], <span style="color:#f92672">&#34;funder&#34;</span> : [ {<span style="color:#f92672">&#34;id&#34;</span>: <span style="color:#e6db74">&#34;&lt;funder ID&gt;&#34;</span>, <span style="color:#f92672">&#34;title&#34;</span>: <span style="color:#e6db74">&#34;&lt;funder title&gt;&#34;</span>} ], <span style="color:#f92672">&#34;institution&#34;</span> : [ {<span style="color:#f92672">&#34;id&#34;</span>: <span style="color:#e6db74">&#34;&lt;institution ROR&gt;&#34;</span>, <span style="color:#f92672">&#34;title&#34;</span>: <span style="color:#e6db74">&#34;&lt;institution name&gt;&#34;</span>} ], <span style="color:#f92672">&#34;checks&#34;</span>: [<span style="color:#e6db74">&#34;&lt;list of routes calculated, (see Route IDs below)&gt;&#34;</span>] }, <span style="color:#f92672">&#34;compliant&#34;</span> : <span style="color:#e6db74">&#34;&lt;(bool) true|false if there is at least one compliant card in the list of cards to show the user&gt;&#34;</span>, <span style="color:#f92672">&#34;results&#34;</span> : [ {<span style="color:#f92672">&#34;&lt;route response objects as per the below&gt;&#34;</span>: <span style="color:#e6db74">&#34;&#34;</span>} ], <span style="color:#f92672">&#34;cards&#34;</span> : [ {<span style="color:#f92672">&#34;&lt;cards to be displayed as per the below&gt;&#34;</span> : <span style="color:#e6db74">&#34;&#34;</span>} ] } </code></pre></div><p>Under <code>request.journal.price_data_years</code> you may find a list of years in which this journal&rsquo;s price data has been provided to the <a href="https://www.coalition-s.org/journal-comparison-service/">Journal Comparison Service</a>. If this is present it means that for all the years listed the journal has provided data to that cOAlition S service. The most recent possible data that the service could hold is for the previous calendar year. For example, if the current year is 2023, then the most recent price data possible would be for 2022.</p> <h3 id="per-route-response-data">Per-Route response data</h3> <p>For each route, there is a general response format:</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{ <span style="color:#f92672">&#34;route&#34;</span> : <span style="color:#e6db74">&#34;&lt;the ID of the route (see Route IDs below)&gt;&#34;</span>, <span style="color:#f92672">&#34;compliant&#34;</span> : <span style="color:#e6db74">&#34;&lt;the Compliance ID for this route result (see below)&#34;</span>, <span style="color:#f92672">&#34;qualifications&#34;</span> : [ {<span style="color:#f92672">&#34;&lt;qualification id&gt; (see below)&#34;</span> : { <span style="color:#f92672">&#34;&lt;qualification specific data (if needed)&gt;&#34;</span> : <span style="color:#e6db74">&#34;&#34;</span> }} ], <span style="color:#f92672">&#34;issn&#34;</span> : [<span style="color:#e6db74">&#34;&lt;the ISSN checked for this result, if there is one&gt;&#34;</span>], <span style="color:#f92672">&#34;funder&#34;</span> : <span style="color:#e6db74">&#34;&lt;the funder checked on this result, if there is one&gt;&#34;</span>, <span style="color:#f92672">&#34;ror&#34;</span> : <span style="color:#e6db74">&#34;the ROR relevant to this result, if there is one&gt;&#34;</span>, <span style="color:#f92672">&#34;log&#34;</span> : [ { <span style="color:#f92672">&#34;code&#34;</span> : <span style="color:#e6db74">&#34;&lt;algorithm transition code (see below)&gt;&#34;</span>, <span style="color:#f92672">&#34;parameters&#34;</span> : { <span style="color:#f92672">&#34;&lt;parameter name&gt;&#34;</span> : [<span style="color:#e6db74">&#34;&lt;parameter value&gt;&#34;</span>] } } ] } </code></pre></div><h4 id="route-ids">Route IDs</h4> <ul> <li><code>fully_oa</code> - Fully OA route</li> <li><code>self_archiving</code> - Self Archiving route</li> <li><code>ta</code> - Transformative Agreement route</li> <li><code>tj</code> - Transformative Journal route</li> <li><code>hybrid</code> - Hybrid Journal route</li> </ul> <h4 id="compliance-ids">Compliance IDs</h4> <ul> <li><code>yes</code> - Route offers compliance</li> <li><code>no</code> - Route does not offer compliance</li> <li><code>unknown</code> - Not known if route offers compliance</li> </ul> <h4 id="qualification-ids">Qualification IDs</h4> <ul> <li><code>doaj_under_review</code> - the journal is in the DOAJ&rsquo;s &ldquo;in progress&rdquo; or &ldquo;under review&rdquo; list, not the public DOAJ <ul> <li>no qualification specific data required</li> </ul> </li> <li><code>rights_retention_author_advice</code> - the journal does not have a self-archiving (SA) policy and does not appear in the rights retention data source <ul> <li>no qualification specific data required</li> </ul> </li> <li><code>corresponding_authors</code> - the transformative agreement (TA) is only open to corresponding authors <ul> <li>no qualification specific data required</li> </ul> </li> <li><code>oa_exception_caveat</code> - the journal was OA according to the cOAlition S rules, but not present in DOAJ. <ul> <li><code>caveat</code> - As the journal does not appear in DOAJ it may have caveats to the scope of the OA support</li> </ul> </li> </ul> <h4 id="log">Log</h4> <p>The log provides a list of decisions made by the algorithm, in order of traversal. This allows you to see the path through the algorithm that was taken to reach each decision, along with any relevant parameters.</p> <p>See the table below for a full list of decisions, their meanings, and the parameters that may be associated.</p> <p>For example, items such as this may be present:</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{ <span style="color:#f92672">&#34;log&#34;</span> : [ { <span style="color:#f92672">&#34;code&#34;</span> : <span style="color:#e6db74">&#34;FullOA.InDOAJ&#34;</span> }, { <span style="color:#f92672">&#34;code&#34;</span> : <span style="color:#e6db74">&#34;FullOA.Compliant&#34;</span>, <span style="color:#f92672">&#34;parameters&#34;</span> : { <span style="color:#f92672">&#34;licence&#34;</span> : [<span style="color:#e6db74">&#34;CC BY&#34;</span>, <span style="color:#e6db74">&#34;CC-BY-SA&#34;</span>] } } ] } </code></pre></div><h5 id="full-oa-route-codes">Full OA Route Codes</h5> <table> <thead> <tr> <th>Code</th> <th>Meaning</th> <th>Property</th> <th>Property Value</th> </tr> </thead> <tbody> <tr> <td>FullOA.NoException</td> <td>The Journal is not in the cOAlition S list of compliant OA Journals which are not in DOAJ</td> <td></td> <td></td> </tr> <tr> <td>FullOA.Exception</td> <td>The Journal is in the cOAlition S list of compliant OA Journals which are not in DOAJ</td> <td></td> <td></td> </tr> <tr> <td>FullOA.NotInDOAJ</td> <td>Journal not found in DOAJ</td> <td></td> <td></td> </tr> <tr> <td>FullOA.InProgressDOAJ</td> <td>Journal application found in DOAJ</td> <td></td> <td></td> </tr> <tr> <td>FullOA.NotInProgressDOAJ</td> <td>No application found in DOAJ</td> <td></td> <td></td> </tr> <tr> <td>FullOA.InDOAJ</td> <td>Journal found in DOAJ</td> <td></td> <td></td> </tr> <tr> <td>FullOA.Compliant</td> <td>Journal properties are compliant</td> <td>licence</td> <td>List of Journal licences</td> </tr> <tr> <td>FullOA.Unknown</td> <td>Journal properties are unclear</td> <td>missing</td> <td>List of missing properties</td> </tr> <tr> <td>FullOA.NonCompliant</td> <td>Journal properties are non-compliant</td> <td>license</td> <td>List of Journal licences</td> </tr> </tbody> </table> <h5 id="self-archiving-route-codes">Self-Archiving Route Codes</h5> <table> <thead> <tr> <th>Code</th> <th>Meaning</th> <th>Property</th> <th>Property Value</th> </tr> </thead> <tbody> <tr> <td>SA.RRException</td> <td>Journal was found in JCT&rsquo;s list of journals which explicitly do not permit the Rights Retention strategy</td> <td></td> <td></td> </tr> <tr> <td>SA.RRNoException</td> <td>The Journal was <em>not</em> found in JCT&rsquo;s list of journals which explicitly do not permit the Rights Retention strategy</td> <td></td> <td></td> </tr> <tr> <td>SA.InOAB</td> <td>Journal was found in Open Access Button (OAB)</td> <td></td> <td></td> </tr> <tr> <td>SA.NotInOAB</td> <td>Journal was not found in OAB</td> <td></td> <td></td> </tr> <tr> <td>SA.OABNonCompliant</td> <td>The record in OAB did not comply with the funder&rsquo;s requirements</td> <td>licence</td> <td>List of allowed SA licenses</td> </tr> <tr> <td></td> <td></td> <td>embargo</td> <td>Embargo length (list of length 1)</td> </tr> <tr> <td></td> <td></td> <td>version</td> <td>List of allowed SA versions</td> </tr> <tr> <td>SA.OABIncomplete</td> <td>Some data was missing from the OAB record, no determination could be made</td> <td>missing</td> <td>List of missing properties</td> </tr> <tr> <td>SA.OABCompliant</td> <td>The record in OAB complied with the funder&rsquo;s requirements</td> <td>licence</td> <td>List of allowed SA licences</td> </tr> <tr> <td></td> <td></td> <td>embargo</td> <td>Embargo length (list of length 1)</td> </tr> <tr> <td></td> <td></td> <td>version</td> <td>List of allowed SA versions</td> </tr> <tr> <td>SA.FunderRRNotActive</td> <td>Funder has not adopted the Rights Retention strategy</td> <td></td> <td></td> </tr> <tr> <td>SA.FunderRRActive</td> <td>Funder has adopted the Rights Retention strategy</td> <td></td> <td></td> </tr> <tr> <td>SA.Unknown</td> <td>Self-Archiving status could not be determined</td> <td></td> <td></td> </tr> <tr> <td>SA.NonCompliant</td> <td>Self-Archiving is not possible under current circumstances</td> <td></td> <td></td> </tr> <tr> <td>SA.Compliant</td> <td>Self-Archiving is permitted via Rights Retention</td> <td></td> <td></td> </tr> </tbody> </table> <h5 id="transformative-agreement-route-codes">Transformative Agreement Route Codes</h5> <table> <thead> <tr> <th>Code</th> <th>Meaning</th> <th>Property</th> <th>Property Value</th> </tr> </thead> <tbody> <tr> <td>TA.NoTA</td> <td>No TA was found that matched the query parameters</td> <td></td> <td></td> </tr> <tr> <td>TA.Exists</td> <td>A TA was found that matched the query parameters</td> <td></td> <td></td> </tr> <tr> <td>TA.NotActive</td> <td>The TA that was found is not currently applicable</td> <td></td> <td></td> </tr> <tr> <td>TA.Active</td> <td>The TA that was found is currently applicable</td> <td></td> <td></td> </tr> <tr> <td>TA.Unknown</td> <td>It was not clear if the parameters of the TA meet the funder&rsquo;s criteria</td> <td></td> <td></td> </tr> <tr> <td>TA.NonCompliant</td> <td>The parameters of the TA do not meet the funder&rsquo;s criteria</td> <td></td> <td></td> </tr> <tr> <td>TA.Compliant</td> <td>The TA is compliant with the funder&rsquo;s requirements</td> <td></td> <td></td> </tr> </tbody> </table> <h5 id="transformative-journals-route-codes">Transformative Journals Route Codes</h5> <table> <thead> <tr> <th>Code</th> <th>Meaning</th> <th>Property</th> <th>Property Value</th> </tr> </thead> <tbody> <tr> <td>TJ.NoTJ</td> <td>The Journal was not registered as a TJ</td> <td></td> <td></td> </tr> <tr> <td>TJ.Exists</td> <td>The Journal is registered as a TJ</td> <td></td> <td></td> </tr> <tr> <td>TJ.FunderNonCompliant</td> <td>The TJ does not meet the funder&rsquo;s criteria</td> <td></td> <td></td> </tr> <tr> <td>TJ.Compliant</td> <td>The TJ is compliant with the Plan S / funder requirements</td> <td></td> <td></td> </tr> </tbody> </table> <h5 id="hybrid-journals-route-codes">Hybrid Journals Route Codes</h5> <table> <thead> <tr> <th>Code</th> <th>Meaning</th> <th>Property</th> <th>Property Value</th> </tr> </thead> <tbody> <tr> <td>Hybrid.NotInOAW</td> <td>The Journal was not registered in OA.Works</td> <td></td> <td></td> </tr> <tr> <td>Hybrid.InOAW</td> <td>The Journal was registered in OA.Works</td> <td></td> <td></td> </tr> <tr> <td>Hybrid.NonCompliant</td> <td>The properites of the hybrid journal do not meet the funder&rsquo;s requirements</td> <td>licence</td> <td>List of allowed hybrid licences</td> </tr> <tr> <td>Hybrid.Unknown</td> <td>There was not sufficient information to determine if the hybrid journal meets the funder&rsquo;s requirements</td> <td>missing</td> <td>List of properties missing</td> </tr> <tr> <td>Hybrid.Compliant</td> <td>The properties of the hybrid journal are compliant with the funder&rsquo;s requirements</td> <td>licence</td> <td>List of allowed publishing licences</td> </tr> </tbody> </table> <h3 id="cards-to-show-the-user">Cards to show the user</h3> <p>The list of cards in the <code>cards</code> section of the response defines those particular routes to compliance which the funder wants the user to be made aware of. Cards are shown based on the compliance routes in the <code>results</code> section of the API response, and only cards which should be shown to the user will be listed. The content of the <code>cards</code> section of the response contains the full definitions of each card, which you can display to the user using the language files provided for that funder (see below).</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{ <span style="color:#f92672">&#34;id&#34;</span>: <span style="color:#e6db74">&#34;[card_id]&#34;</span>, <span style="color:#f92672">&#34;match_routes&#34;</span>: { <span style="color:#f92672">&#34;must&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id]&#34;</span> ], <span style="color:#f92672">&#34;or&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id]&#34;</span>, <span style="color:#e6db74">&#34;[route_id]&#34;</span> ], <span style="color:#f92672">&#34;not&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id]&#34;</span> ] }, <span style="color:#f92672">&#34;match_qualifications&#34;</span>: { <span style="color:#f92672">&#34;must&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id].[qualification_id]&#34;</span> ], <span style="color:#f92672">&#34;or&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id].[qualification_id]&#34;</span>, <span style="color:#e6db74">&#34;[route_id].[qualification_id]&#34;</span> ], <span style="color:#f92672">&#34;not&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id].[qualification_id]&#34;</span> ] }, <span style="color:#f92672">&#34;preferred&#34;</span>: <span style="color:#e6db74">&#34;true|false&#34;</span>, <span style="color:#f92672">&#34;compliant&#34;</span>: <span style="color:#e6db74">&#34;true|false&#34;</span>, <span style="color:#f92672">&#34;display_if_compliant&#34;</span>: [ <span style="color:#e6db74">&#34;[route_id]&#34;</span>, <span style="color:#e6db74">&#34;[route_id]&#34;</span> ], <span style="color:#f92672">&#34;modal&#34;</span>: <span style="color:#e6db74">&#34;[modal_id]&#34;</span> } </code></pre></div><ul> <li><code>cards[].id</code> - a unique id for the card, an arbitrary string, but which will be used to identify the card throughout the language files</li> <li><code>cards[].match_routes</code> - match rules for compliant routes to determine whether or not to show this card <ul> <li><code>must</code> - all routes listed must be compliant</li> <li><code>or</code> - at least one of the routes listed must be compliant</li> <li><code>not</code> - none of the routes listed may be compliant</li> </ul> </li> <li><code>cards[].match_qualifications</code> - match rules for qualifications present in calculated routes <ul> <li><code>must</code> - all qualifications listed must be present</li> <li><code>or</code> - at least one of the qualifications listed must be present</li> <li><code>not</code> - none of the qualifications listed may be present</li> </ul> </li> <li><code>cards[].preferred</code> - the card represents a preferred route to compliance by the funder</li> <li><code>cards[].compliant</code> - the card represents a route to compliance, and the presence of at least one in the results will trigger the compliant style in the front end.</li> <li><code>cards[].display_if_compliant</code> - the list of routes, in order, to display information about whether or not they are compliant. If you leave this blank then no route-specific guidance will be displayed, but the <code>default</code> text for the card will be displayed anyway, so you only need to use this option if the card could display information about multiple routes, and you wish to control which information is displayed depending on which routes are compliant</li> <li><code>cards[].modal</code> - the modal to bind to the card&rsquo;s overall modal (other modals can be specified inline in the card text as normal)</li> </ul> <h2 id="funder-specific-language">Funder Specific Language</h2> <p>Each funder in JCT may specify custom language for how the compliance information should be interpreted and displayed to end users. This information is optimised for use in the JCT user interface. Nonetheless it is also available via the API for use by any downstream systems.</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">GET /funder_language/&lt;funder id&gt; </code></pre></div><p>or</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">GET /funder_language/&lt;funder_id&gt;/&lt;language_code&gt; </code></pre></div><p>Use of the URL without language code will return the default language pack (English). If you request a language which is not provided for that funder, you will get the default language pack in response.</p> <p>The response is a JSON document which contains all of the language used by the JCT front end, which covers:</p> <ul> <li>General site text specific to the funder</li> <li>Text for all API log codes</li> <li>Content for all compliance cards</li> <li>Any modals attached to any part of the information</li> </ul> <p>The support for multiple languages can vary across funders. Most funders support all of the current translations (see below), but where funders have customised the language of their results for their own needs, unless translations of those customisations are also provided, they will be in the default language.</p> <p>The list of broadly supported languages is currently:</p> <ul> <li>English (en) <em>default</em></li> <li>French (fr)</li> </ul> <p>Examples:</p> <ul> <li>Wellcome Trust: <a href="https://api.journalcheckertool.org/funder_language/wellcome">https://api.journalcheckertool.org/funder_language/wellcome</a></li> <li>Fonds de recherche du Québec, in French : <a href="https://api.journalcheckertool.org/funder_language/quebecresearchfunds/fr">https://api.journalcheckertool.org/funder_language/quebecresearchfunds/fr</a></li> <li>UKRI: <a href="https://api.journalcheckertool.org/funder_language/unitedkingdomresearchinnovationukri">https://api.journalcheckertool.org/funder_language/unitedkingdomresearchinnovationukri</a></li> </ul> <h2 id="transformative-journals">Transformative Journals</h2> <p>Determine if a journal is a transformative journal, using the issn, and optionally the funder:</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">GET /tj/<span style="color:#f92672">{</span>issn<span style="color:#f92672">}</span> </code></pre></div><p>or</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">GET /tj/<span style="color:#f92672">{</span>issn<span style="color:#f92672">}</span>?funder<span style="color:#f92672">={</span>funder_id<span style="color:#f92672">}</span> </code></pre></div><p>where the <code>{funder_id}</code> comes from <a href="/funder-ids">this list</a>.</p> <p>Response format:</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{ <span style="color:#f92672">&#34;issn&#34;</span> : <span style="color:#e6db74">&#34;&lt;issn requested&gt;&#34;</span>, <span style="color:#f92672">&#34;transformative_journal&#34;</span> : <span style="color:#66d9ef">true</span> } </code></pre></div><p>OR <code>404</code> if the record not found in the TJ database, or if the funder does not recognise the TJ as compliant with their policy.</p> <p>Examples:</p> <ul> <li>PLoS One (not a Transformative Journal): <a href="https://api.journalcheckertool.org/tj/1932-6203">https://api.journalcheckertool.org/tj/1932-6203</a></li> <li>Journal of Cell Science (a Transformative Journal): <a href="https://api.journalcheckertool.org/tj/0021-9533">https://api.journalcheckertool.org/tj/0021-9533</a></li> </ul> <h2 id="transformative-agreements">Transformative Agreements</h2> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">GET /ta?issn<span style="color:#f92672">={</span>issn<span style="color:#f92672">}</span>&amp;ror<span style="color:#f92672">={</span>ror<span style="color:#f92672">}</span> </code></pre></div><p>Response format:</p> <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{ <span style="color:#f92672">&#34;issn&#34;</span> : [<span style="color:#e6db74">&#34;&lt;issn in the TA&gt;&#34;</span>], <span style="color:#f92672">&#34;ror&#34;</span> : <span style="color:#e6db74">&#34;&lt;ror in the TA&gt;&#34;</span>, <span style="color:#f92672">&#34;result&#34;</span> : { <span style="color:#f92672">&#34;compliant&#34;</span>: <span style="color:#e6db74">&#34;&lt;yes|no|unknown&gt;&#34;</span>, <span style="color:#f92672">&#34;qualifications&#34;</span>: [ { <span style="color:#f92672">&#34;&lt;qualification id&gt;&#34;</span>: { <span style="color:#f92672">&#34;&lt;qualification specific data (if needed)&gt;&#34;</span>: <span style="color:#e6db74">&#34;&#34;</span> } } ], <span style="color:#f92672">&#34;log&#34;</span>: [ { <span style="color:#f92672">&#34;action&#34;</span>: <span style="color:#e6db74">&#34;&lt;description of the action (see above for details.)&gt;&#34;</span>, <span style="color:#f92672">&#34;result&#34;</span>: <span style="color:#e6db74">&#34;&lt;the outcome of the action (optional, depending on circumstance)&gt;&#34;</span> } ] } } </code></pre></div><p>OR <code>404</code> if no TA exists for that combination.</p> <p>Examples:</p> <ul> <li>PLoS One, Oxford (No such TA exists): <a href="https://api.journalcheckertool.org/ta?issn=1932-6203&amp;ror=052gg0110">https://api.journalcheckertool.org/ta?issn=1932-6203&amp;ror=052gg0110</a></li> <li>Acta Zoologica, University of Maribor (TA exists): <a href="https://api.journalcheckertool.org/ta?issn=1463-6395&amp;ror=01d5jce07">https://api.journalcheckertool.org/ta?issn=1463-6395&amp;ror=01d5jce07</a></li> </ul> </div> <section class="row row--centered patterned-section" style="max-width: 100%;"> <div class="wave" aria-hidden="true"> <svg preserveaspectratio="none" viewbox="0 0 1200 120" xmlns="http://www.w3.org/2000/svg" style="width: 125%; height: 75px; transform: scaleX(-1);"> <path d="M0 0v46.29c47.79 22.2 103.59 32.17 158 28 70.36-5.37 136.33-33.31 206.8-37.5 73.84-4.36 147.54 16.88 218.2 35.26 69.27 18 138.3 24.88 209.4 13.08 36.15-6 69.85-17.84 104.45-29.34C989.49 25 1113-14.29 1200 52.47V0z" opacity=".25"></path> <path d="M0 0v15.81c13 21.11 27.64 41.05 47.69 56.24C99.41 111.27 165 111 224.58 91.58c31.15-10.15 60.09-26.07 89.67-39.8 40.92-19 84.73-46 130.83-49.67 36.26-2.85 70.9 9.42 98.6 31.56 31.77 25.39 62.32 62 103.63 73 40.44 10.79 81.35-6.69 119.13-24.28s75.16-39 116.92-43.05c59.73-5.85 113.28 22.88 168.9 38.84 30.2 8.66 59 6.17 87.09-7.5 22.43-10.89 48-26.93 60.65-49.24V0z" opacity=".5"></path> <path d="M0 0v5.63C149.93 59 314.09 71.32 475.83 42.57c43-7.64 84.23-20.12 127.61-26.46 59-8.63 112.48 12.24 165.56 35.4C827.93 77.22 886 95.24 951.2 90c86.53-7 172.46-45.71 248.8-84.81V0z"></path> </svg> </div> <p class="col col--1of2 alert">The information provided by the <em>Journal Checker Tool</em> represents cOAlition S’s current understanding in relation to the policies of the journals contained within it. We will endeavour to keep it up to date and accurate, but we do not accept any liability in relation to any errors or omissions.</p> </section></div> </main> <footer> <div class="container"> <div class="row"><div class="col col--1of2"> <a href="https://www.coalition-s.org"><img src="/img/Plan-S-logo-white.svg" style="width: 236px; margin-bottom: 40px"></a> <address> cOAlition S Office<br/> European Science Foundation<br/> 1, quai Lezay – Marnésia<br/> 67080 Strasbourg – France </address> <p>Content on this site is licensed under a <a href="https://creativecommons.org/licenses/by/4.0/" target="blank" rel="noferrer noopener">Creative Commons (CC BY) Attribution 4.0 International license</a>.</p> </div><div class="col col--1of2 col--right"> <button class="button button--secondary modal-trigger" id="feedback" data-modal="feedback"> <svg width="24" height="25" viewbox="0 0 24 25" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M4.88002 24.4048C4.99391 24.4685 5.11979 24.5 5.24492 24.5C5.4165 24.5 5.58734 24.4416 5.72445 24.3269L10.9109 20.0044H14.2242C19.6018 20.0044 23.9768 15.6286 23.9768 10.2518C23.9768 4.87501 19.6018 0.5 14.225 0.5H9.75255C4.37501 0.5 0 4.87501 0 10.2518C0 13.8438 2.01854 17.1609 5.18872 18.8527L4.50389 23.6443C4.45968 23.9523 4.60953 24.2542 4.88002 24.4048ZM1.49855 10.2518C1.49855 5.70071 5.20071 1.99855 9.75255 1.99855H14.2242C18.7761 1.99855 22.4782 5.69996 22.4782 10.2518C22.4782 14.8036 18.7761 18.5058 14.2242 18.5058H10.6397C10.4644 18.5058 10.295 18.5672 10.1602 18.6789L6.26243 21.9277L6.74721 18.5298C6.79442 18.2016 6.62059 17.8824 6.32013 17.7438C3.39122 16.3891 1.49855 13.449 1.49855 10.2518ZM6.74347 8.01597H17.2333C17.6477 8.01597 17.9826 7.6803 17.9826 7.2667C17.9826 6.8531 17.6477 6.51743 17.2333 6.51743H6.74347C6.32987 6.51743 5.99419 6.8531 5.99419 7.2667C5.99419 7.6803 6.32987 8.01597 6.74347 8.01597ZM6.74347 14.0102H12.7377C13.152 14.0102 13.4869 13.6752 13.4869 13.2609C13.4869 12.8473 13.152 12.5116 12.7377 12.5116H6.74347C6.32987 12.5116 5.99419 12.8473 5.99419 13.2609C5.99419 13.6752 6.32987 14.0102 6.74347 14.0102ZM17.2333 11.0131H6.74347C6.32987 11.0131 5.99419 10.6774 5.99419 10.2638C5.99419 9.8502 6.32987 9.51452 6.74347 9.51452H17.2333C17.6477 9.51452 17.9826 9.8502 17.9826 10.2638C17.9826 10.6774 17.6477 11.0131 17.2333 11.0131Z" fill="black"></path> </svg> Send us feedback </button> <p> <a href="/transformative-journals"> Transformative&nbsp;Journals </a> • <a href="/transformative-agreements"> Transformative&nbsp;Agreements&nbsp;Public&nbsp;Data </a> • <a href="/ta-search"> Transformative&nbsp;Agreements&nbsp;Search </a> • <a href="/exception-lists"> Exception&nbsp;Lists </a> • <a href="/jcs"> Journals&nbsp;participating&nbsp;in&nbsp;JCS </a> • <a href="/apidocs"> API&nbsp;Documentation </a> </p> <p> <a href="/widget"> Embeddable&nbsp;Widget </a> • <a href="/faq"> FAQ </a> • <a href="/notices#privacy_notice"> Privacy&nbsp;Notice </a> • <a href="/notices#disclaimer_and_copyright"> Disclaimer&nbsp;&&nbsp;Copyright </a> • <a href="/acknowledgements"> Acknowledgements </a> • <a href="/release-history"> Release&nbsp;History </a> </p> </div></div> </div> </footer> <div id="jct_modal_container"> </div> <script> jct.bindModalTriggers(); </script> </body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10