Skip to content

Commit

Permalink
Discourage entry numbers usage in the API
Browse files Browse the repository at this point in the history
  • Loading branch information
blokhin committed Jan 13, 2025
1 parent ac42be7 commit 45e34b2
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -863,6 +863,8 @@ <h3 id="REST-endpoint">&sect;1.3. REST-alike download endpoint</h3>
"props": "thermal expansion"
}</div>

<p class="view">Please, note: we do not support querying by entry IDs in the API intentionally. The entries might be updated or changed with time, therefore do not rely on their IDs in the data mining in mass manner. Use <a href="https://mpds.io/entry/S377634">GUI</a> to extract particular entries by their IDs.</p>

<p class="view">By default the response has <span class="t">json</span> format, containing the following properties: <span class="t">out</span> (list <i>i.e.</i> array of the MPDS entries), <span class="t">npages</span> (number of pages in the selected or default pagination), <span class="t">page</span> (current page number), <span class="t">count</span> (total number of hits), and <span class="t">error</span> (should be <span class="t">null</span>). Some other properties might be added in future.</p>

<p class="view">Each kind of entries (<i>i.e.</i> S- or P-entries) has its own specific properties in <strong>JSON</strong> (see below).</p>
Expand Down

0 comments on commit 45e34b2

Please sign in to comment.