CINXE.COM

<!doctype html> <html> <head> <meta charset="utf-8"> <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> <title>Mendeley API Reference</title> <link href="stylesheets/screen.css" rel="stylesheet" type="text/css" media="screen" /> <link href="stylesheets/print.css" rel="stylesheet" type="text/css" media="print" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script> <script src="javascripts/all.js" type="text/javascript"></script> <script> $(function() { setupLanguages(["shell"]); }); </script> </head> <body class="index"> <a href="#" id="nav-button"> NAV <img src="images/navbar.png" /> </a> <div class="tocify-wrapper"> <img src="images/logo.png" /> <div class="lang-selector"> <a href="#" data-language-name="shell">cURL</a> </div> <div class="search"> <input type="text" class="search" id="input-search" placeholder="Search"> </div> <ul class="search-results"></ul> <div id="toc"> </div> <ul class="toc-footer"> <li><a href="http://dev.mendeley.com/">Sign Up for a Developer Key</a></li> <li><a href='http://github.com/tripit/slate'>Documentation Powered by Slate</a></li> </ul> </div> <div class="page-wrapper"> <div class="dark-box"></div> <div class="content"> <h1 id="introduction">Introduction</h1> This is the reference documentation for the Mendeley API. It contains details of the endpoints that the API offers, and examples of how to use it. For more information, see the <a href="http://dev.mendeley.com">developer portal</a>. When working with collections, paged results and ordering please consult the <a href="http://dev.mendeley.com/reference/topics/pagination.html">pagination section on our developer portal</a> <h1 id="annotations">Annotations</h1> <h2 id="annotation-attributes">Annotation attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>identifier (UUID)</td> </tr> <tr> <td>created</td> <td>string</td> <td>date the annotation was created. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>last_modified</td> <td>string</td> <td>date the annotation was updated. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>color</td> <td>color</td> <td>RGB values</td> </tr> <tr> <td>text</td> <td>string</td> <td>text value of the annotation</td> </tr> <tr> <td>positions</td> <td>array of HighlightBox’s</td> <td>wrapper object contains page and coordinates of the annotation bounding box.</td> </tr> <tr> <td>privacy_level</td> <td>string</td> <td>public, group or private.</td> </tr> <tr> <td>document_id</td> <td>string</td> <td>UUID of the document which the file is attached to.</td> </tr> <tr> <td>profile_id</td> <td>string</td> <td>UUID of the user that created the annotation.</td> </tr> <tr> <td>filehash</td> <td>string</td> <td>filehash of which the annotation belongs to.</td> </tr> </tbody></table> <h2 id="retrieving-annotations">Retrieving annotations</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/annotations' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-annotation.1+json' { "id": "d6526d08-22f2-4c1f-b80b-092e6e3df528", "color": { "r": 255, "g": 255, "b": 0 }, "text": "This is a sticky note", "positions": [ { "top_left": { "x": 269.035, "y": 695.428 }, "bottom_right": { "x": 269.035, "y": 695.428 }, "page": 1 } ], "created": "2011-10-07T14:19:09.000Z", "last_modified": "2011-10-07T14:19:37.000Z", "privacy_level": "private", "filehash": "bd3293b2-d20c-0d9f-3773-df51a506c7b2", "document_id": "2a3f09be-75b0-3bf9-bdbd-838c5e588969", "profile_id": "e2cc65ad-5ef2-3838-b934-737fdb3b196d" } </code></pre> <pre><code class="highlight java">AnnotationList annotationList = sdk.getAnnotations(); List<Annotation> annotations = annotationList.annotations; Page next = annotationList.next; </code></pre> Retrieve all your annotations <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/annotations</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>group_id</td> <td>string</td> <td>UUID of the group you would like to get the annotations from. This will only return all the annotations in that group.</td> </tr> <tr> <td>document_id</td> <td>string</td> <td>UUID of the document you would like to get the annotations from. This will only return the annotations associated with that document.</td> </tr> <tr> <td>modified_since</td> <td>string</td> <td>returns only documents modified since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>deleted_since</td> <td>string</td> <td>returns only documents deleted since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500</td> </tr> <tr> <td>marker</td> <td>string</td> <td>a marker for the last key in the previous page (automatically generated, here for completeness)</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> Will return a paginated collection of all private annotations in your library. <h2 id="creating-an-annotation">Creating an annotation</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/annotations' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-annotation.1+json' \ -H 'Accept: application/vnd.mendeley-annotation.1+json' \ --data-binary $'{ "color": {"r": 255,"g": 255, "b": 0}, "text": "This is a sticky note", "positions": [ {"top_left": {"x": 269.035, "y": 695.428}, "bottom_right": { "x": 269.035,"y": 695.428}, "page": 1} ], "privacy_level": "private", "filehash": "bd3293b2-d20c-0d9f-3773-df51a506c7b2","document_id": "2bf33ebd-7cd1-3786-903d-d74d04958e40", "profile_id": "e2cc65ad-5ef2-3838-b934-737fdb3b196d"}' { "id": "f2405d7a-466b-46f3-8f2f-ab57003dafcd", "color": { "r": 255, "g": 255, "b": 0 }, "text": "This is a sticky note", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "positions": [ { "top_left": { "x": 269.035, "y": 695.428 }, "bottom_right": { "x": 269.035, "y": 695.428 }, "page": 1 } ], "created": "2014-07-03T11:17:11.868Z", "last_modified": "2014-07-03T11:17:11.868Z", "privacy_level": "private", "filehash": "bd3293b2-d20c-0d9f-3773-df51a506c7b2", "document_id": "2bf33ebd-7cd1-3786-903d-d74d04958e40" } </code></pre> <pre><code class="highlight java">List<Box> positions = new ArrayList<Box>(); positions.add(new Box(new Point(269.035, 695.428), new Point(269.035, 695.428), 1)); Annotation annotation = new Annotation.Builder() .setColor(Color.rgb(255, 255, 0)) .setText("This is a sticky note") .setPositions(positions) .setPrivacyLevel(Annotation.PrivacyLevel.PRIVATE) .setFileHash("bd3293b2-d20c-0d9f-3773-df51a506c7b2") .setDocumentId("2bf33ebd-7cd1-3786-903d-d74d04958e40") .setProfileId("e2cc65ad-5ef2-3838-b934-737fdb3b196d") .build(); sdk.postAnnotation(annotation); </code></pre> Creates a new annotation. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/annotations</code> <h3 id="returns">Returns</h3> A 201 Created response containing the annotation object. <h2 id="updating-an-annotation">Updating an annotation</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/annotations/f2405d7a-466b-46f3-8f2f-ab57003dafcd' -X PATCH -H 'Authorization: Bearer <ACCESS_TOKEN>' -H 'Content-Type: application/vnd.mendeley-annotation.1+json' -H 'Accept: application/vnd.mendeley-annotation.1+json' --data-binary $'{"text" : "My new sticky note"}' { "id": "f2405d7a-466b-46f3-8f2f-ab57003dafcd", "color": { "r": 255, "g": 255, "b": 0 }, "text": "My new sticky note", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "positions": [ { "top_left": { "x": 269.035, "y": 695.428 }, "bottom_right": { "x": 269.035, "y": 695.428 }, "page": 1 } ], "created": "2014-07-03T11:17:11.868Z", "last_modified": "2014-07-03T11:26:07.311Z", "privacy_level": "private", "filehash": "bd3293b2-d20c-0d9f-3773-df51a506c7b2", "document_id": "2bf33ebd-7cd1-3786-903d-d74d04958e40" } </code></pre> <pre><code class="highlight java">Annotation amendment = new Annotation.Builder().setColor(Color.rgb(128, 0, 128)).build(); sdk.patchAnnotation("f2405d7a-466b-46f3-8f2f-ab57003dafcd", amendment); </code></pre> Updates a specific annotation. Any parameters not provided will be left unchanged. The fields that can be updated are: text, color, positions, privacy_level and filehash. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/annotations/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>annotations unique id</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing the annotation object. <h2 id="deleting-an-annotation">Deleting an annotation</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/annotations/f2405d7a-466b-46f3-8f2f-ab57003dafcd' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight java">sdk.deleteAnnotation("f2405d7a-466b-46f3-8f2f-ab57003dafcd"); </code></pre> Deletes an annotation <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE https://api.mendeley.com/annotations/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>annotations unique id</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> If the request is successful then the server will return a 204 No Content response. <h1 id="academic-statuses">Academic Statuses</h1> <h2 id="retrieve-all-academic-statuses">Retrieve all academic statuses</h2> Retrieves all academic statuses. <pre><code class="highlight shell">curl 'https://api.mendeley.com/academic_statuses' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.academic_status.1+json' [ { "description": "Post Doc" }, { "description": "Doctoral Student" }, { "description": "Ph.D. Student" }, { "description": "Student (Postgraduate)" }, { "description": "Student (Master)" }, { "description": "Student (Bachelor)" }, { "description": "Professor" }, { "description": "Associate Professor" }, { "description": "Assistant Professor" }, { "description": "Senior Lecturer" }, { "description": "Lecturer" }, { "description": "Researcher (at an Academic Institution)" }, { "description": "Librarian" }, { "description": "Researcher (at a non-Academic Institution)" }, { "description": "Other Professional" } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/academic_statuses</code> <h3 id="returns">Returns</h3> A 200 OK response containing a all academic statuses <h1 id="catalog-documents">Catalog Documents</h1> <h2 id="core-catalog-document-attributes">Core catalog document attributes</h2> The following attributes are returned by default. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> <tr> <td>title</td> <td>string</td> <td>Title of the document.</td> </tr> <tr> <td>type</td> <td>string</td> <td>The type of the document. Supported types: journal, book, generic, book_section, conference_proceedings, working_paper, report, web_page, thesis, magazine_article, statute, patent, newspaper_article, computer_program, hearing, television_broadcast, encyclopedia_article, case, film, bill.</td> </tr> <tr> <td>abstract</td> <td>string</td> <td>Brief summary of the document.</td> </tr> <tr> <td>source</td> <td>string</td> <td>Publication outlet, i.e. where the document was published.</td> </tr> <tr> <td>year</td> <td>integer</td> <td>Year in which the document was issued/published.</td> </tr> <tr> <td>authors</td> <td>array</td> <td>List of authors of the document, as <a href="#people">person</a> objects.</td> </tr> <tr> <td>identifiers</td> <td>array</td> <td>List of identifiers available for the document. The supported identifiers are: arxiv, doi, isbn, issn, pmid (PubMed), scopus and ssrn.</td> </tr> <tr> <td>keywords</td> <td>array</td> <td>50 each</td> </tr> <tr> <td>link</td> <td>string</td> <td>Link to the document’s page on the Mendeley website.</td> </tr> </tbody></table> <h2 id="additional-catalog-document-attributes">Additional catalog document attributes</h2> The following attributes are available using a <a href="#catalog-document-views">view</a>. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>month</td> <td>integer</td> <td>Month in which the document was issued/published.</td> </tr> <tr> <td>day</td> <td>integer</td> <td>Day in which the document was issued/published.</td> </tr> <tr> <td>revision</td> <td>string</td> <td>Number identifying the item (e.g. a report number).</td> </tr> <tr> <td>pages</td> <td>string</td> <td>range of pages the document covers in the issue, e.g 4-8.</td> </tr> <tr> <td>volume</td> <td>string</td> <td>volume holding the document, e.g “2” from journal volume 2.</td> </tr> <tr> <td>issue</td> <td>string</td> <td>issue holding the document, e.g. “5” for a journal article from journal volume 2, issue 5</td> </tr> <tr> <td>websites</td> <td>array</td> <td>Where the document was accessed from.</td> </tr> <tr> <td>publisher</td> <td>string</td> <td>Publisher of the document.</td> </tr> <tr> <td>city</td> <td>string</td> <td>city where the document was published.</td> </tr> <tr> <td>edition</td> <td>array</td> <td>edition holding the document, e.g. “3” from the third edition of a book.</td> </tr> <tr> <td>institution</td> <td>string</td> <td>Institution in which the document was published.</td> </tr> <tr> <td>series</td> <td>string</td> <td>title of the collection holding the document (e.g. the series title for a book)</td> </tr> <tr> <td>chapter</td> <td>string</td> <td>Chapter number.</td> </tr> <tr> <td>editors</td> <td>array</td> <td>List of editors of the document. Like authors, this is a collection (array) of person objects, which include first_name and last_name (strings), as <a href="#people">person</a> objects.</td> </tr> <tr> <td>file_attached</td> <td>boolean</td> <td></td> </tr> <tr> <td>reader_count</td> <td>integer</td> <td>Total number of users in Mendeley that have the document in their library.</td> </tr> <tr> <td>reader_count_by_academic_status</td> <td>object</td> <td>Number of readers based on their academic status.</td> </tr> <tr> <td>reader_count_by_discipline</td> <td>object</td> <td>Number of readers based on their discipline.</td> </tr> <tr> <td>reader_count_by_country</td> <td>object</td> <td>Number of readers based on their country.</td> </tr> <tr> <td>group_count</td> <td>integer</td> <td>Number of Mendeley groups that this document has been added to.</td> </tr> <tr> <td>imported</td> <td>boolean</td> <td>Whether the document metadata has been imported from a source other than a users library. For example, Scopus and is therefore likely to be of a higher quality.</td> </tr> <tr> <td>has_pdf</td> <td>boolean</td> <td>Whether the catalogue document has an associated full-text pdf suitable for download.</td> </tr> </tbody></table> <h2 id="catalog-document-views">Catalog document views</h2> <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>bib</td> <td>Will return the core fields plus the bibliographic data. This includes: pages, volume, issue, websites, month, publisher, day, city, edition, institution, series, chapter, revision and editors.</td> </tr> <tr> <td>client</td> <td>Will return the core fields plus file_attached and imported.</td> </tr> <tr> <td>stats</td> <td>This view will return the core fields plus the statistics data. This includes: reader_count, reader_count_by_academic_status, reader_count_by_discipline, reader_by_country and group_count.</td> </tr> <tr> <td>all</td> <td>Will return all fields.</td> </tr> </tbody></table> <h2 id="retrieving-catalog-documents">Retrieving catalog documents</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/catalog?doi=10.1016/j.molcel.2009.09.013' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' { "id": "eaede082-7d8b-3f0c-be3a-fb7be685fbe6", "title": "How To Choose a Good Scientific Problem", "type": "journal", "authors": [ { "first_name": "Uri", "last_name": "Alon" } ], "year": 2009, "source": "Molecular Cell", "identifiers": { "doi": "10.1016/j.molcel.2009.09.013", "isbn": "1097-4164 (Electronic)\\r1097-2765 (Linking)", "pmid": "19782018", "issn": "10972765", "arxiv": "z0024" }, "abstract": "Choosing good problems is essential for being a good scientist. But what is a good problem, and how do you choose one? The subject is not usually discussed explicitly within our profession. Scientists are expected to be smart enough to figure it out on their own and through the observation of their teachers. This lack of explicit discussion leaves a vacuum that can lead to approaches such as choosing problems that can give results that merit publication in valued journals, resulting in a job and tenure. ?? 2009 Elsevier Inc. All rights reserved." } </code></pre> <pre><code class="highlight python">doc = mendeley.catalog.by_identifier(doi='10.1016/j.molcel.2009.09.013') print doc.title </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> Retrieve catalog documents by identifier. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/catalog</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>arxiv</td> <td>string</td> <td><a href="http://uk.arxiv.org/help/arxiv_identifier">arXiv identifier </a></td> </tr> <tr> <td>doi</td> <td>string</td> <td><a href="http://uk.arxiv.org/help/arxiv_identifier">Digital Object Identifier </a></td> </tr> <tr> <td>isbn</td> <td>string</td> <td><a href="https://www.isbn-international.org">International Standard Book Number</a></td> </tr> <tr> <td>issn</td> <td>string</td> <td><a href="http://www.issn.org">International Standard Serial Number</a></td> </tr> <tr> <td>pmid</td> <td>string</td> <td><a href="http://www.ncbi.nlm.nih.gov/pubmed">PubMed identifier</a></td> </tr> <tr> <td>scopus</td> <td>string</td> <td><a href="http://www.scopus.com/home.url">Scopus identifier</a></td> </tr> <tr> <td>ssrn</td> <td>string</td> <td><a href="http://www.ssrn.com/en/">Social Science Research Network</a></td> </tr> <tr> <td>filehash</td> <td>string</td> <td>filehash of the file</td> </tr> <tr> <td>view</td> <td>string</td> <td>includes core document fields plus additional fields.</td> </tr> </tbody></table> <h2 id="retrieving-a-catalog-document">Retrieving a catalog document</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/catalog/eaede082-7d8b-3f0c-be3a-fb7be685fbe6?view=stats' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' { "id":"eaede082-7d8b-3f0c-be3a-fb7be685fbe6", "title":"How To Choose a Good Scientific Problem", "type":"journal", "authors":[ { "first_name":"Uri", "last_name":"Alon" } ], "year":2009, "source":"Molecular Cell", "identifiers":{ "doi":"10.1016/j.molcel.2009.09.013", "isbn":"1097-4164 (Electronic)\\r1097-2765 (Linking)", "pmid":"19782018", "issn":"10972765", "arxiv":"z0024" }, "reader_count":65955, "reader_count_by_academic_status":{ "Professor":2393, "Associate Professor":1694, "Assistant Professor":1936, "Post Doc":4690, "Ph.D. Student":14964, "Researcher (at an Academic Institution)":3257, "Researcher (at a non-Academic Institution)":2292, "Librarian":592, "Other Professional":2637, "Student (Postgraduate)":4987, "Student (Master)":11939, "Student (Bachelor)":9485, "Senior Lecturer":480, "Lecturer":1025, "Doctoral Student":3579 }, "reader_count_by_subdiscipline":{ "Chemistry":{ "Crystallography":5, "Industrial and Engineering Chemistry":17, "Inorganic Chemistry":41, "Mass Spectrometry":3, "Analytical Chemistry":53, "Applied Chemistry":23, "Chromatography":1, "Physical Chemistry":90, "Photochemistry":5, "Radiochemistry":4, "Polymer Chemistry":30, "Nuclear Magnetic Resonance":9, "Miscellaneous":2525, "Petroleum":5, "Organic Chemistry":116, "Stereochemistry":1, "Theoretical Chemistry":34, "Biochemistry":47 }, "Business Administration":{ "Banks and Banking":4, "Accounting":19, "Industrial Relations":1, "Human Resource Management":14, "Finance and Financial Services":14, "Entrepreneurship":25, "Management Information Systems":27, "International Business":9, "Insurance":1, "Production, Operations and Manufacturing Management":5, "Public and Non-Profit Management":7, "Quality Control":1, "Taxation":3, "Management and Communication":4, "Management and Strategy":36, "Marketing":30, "Miscellaneous":677, "Technological Change":2, "Logistics":3 }, "Medicine":{ "Alcoholism and Addiction":4, "AIDS":11, "Anesthesiology":36, "Allergy":2, "Asthma":1, "Arthritis":1, "Cancer":56, "Biomedical Engineering":54, "Clinical Molecular and Microbiology":19, "Cardiology":47, "Dentistry and Oral Surgery":67, "Communication Disorders":3, "Emergency Medicine and Critical Care":27, "Dermatology":10, "Environmental":4, "Endocrinology":18, "Ophthalmology":20, "Oncology":35, "Occupational and Environmental":8, "Occupational Therapy":6, "Obstetrics":20, "Obesity":2, "Nutrition and Metabolism":26, "Pharmacy":47, "Pharmacology":31, "Pediatrics":33, "Pathology and Forensics":17, "Pain Medicine and Palliative Care":8, "Otolaryngology":13, "Orthopedics":23, "Optometry":11, "Hematology":16, "Histology":2, "Geriatrics and Aging":6, "Gynecology":11, "Gastroenterology and Hepatology":15, "General Medicine":17, "Epidemiology":85, "Family":8, "Neurology":46, "Neuroscience":124, "Nephrology, Urology":17, "Neurobiology":6, "Medical Imaging":33, "Miscellaneous":9166, "Internal Medicine":40, "Rheumatology":14, "Surgery":54, "Toxicology":8, "Tropical":5, "Physiology":27, "Public Health and Community Medicine":74, "Reproductive Medicine":6, "Respiratory and Pulmonary":23, "Nursing":44, "Physiotherapy":49 } }, "reader_count_by_country":{ "Belarus":5, "Portugal":218, "Philippines":41, "Hong Kong":18, "Morocco":5, "Tanzania":15, "Mali":4, "Ecuador":44, "...all countries listed...":99 }, "abstract":"Choosing good problems is essential for being a good scientist. But what is a good problem, and how do you choose one?.........." } </code></pre> <pre><code class="highlight python">doc = mendeley.catalog.get('eaede082-7d8b-3f0c-be3a-fb7be685fbe6', view='stats') print doc.reader_count </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> Retrieve a catalog document by ID. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/catalog/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>the catalog id (UUID)</td> </tr> <tr> <td>view</td> <td>string</td> <td>includes core document fields plus additional fields.</td> </tr> </tbody></table> <h1 id="catalog-search">Catalog Search</h1> The documents returned have the same attributes as the <a href="#catalog-documents">Catalog Documents</a> API. <h2 id="search-by-query">Search by query</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/search/catalog?query=polar+bears&limit=3' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' [ { "id": "52a7f7b4-3cde-399b-a20e-889dc90e62b8", "title": "In the Marine Environment", "type": "journal", "authors": [ { "first_name": "Polar", "last_name": "Bears" } ], "year": 2002, "source": "Arctic", "identifiers": { "issn": "00063185" }, "abstract": "..." }, { "id": "dd18e5ad-74d0-3bfa-a5da-84640ad82976", "title": "Behavior", "type": "book_section", "authors": [ { "first_name": "I", "last_name": "Stirling" } ], "year": 1988, "source": "Polar Bears", "abstract": "..." }, { "id": "248883ce-5377-3aa3-aa84-57163c89d3f6", "title": "Polar Bears", "type": "journal", "authors": [ { "first_name": "Nicholas J", "last_name": "Lunn" }, { "first_name": "Scott", "last_name": "Schliebe" }, { "first_name": "Erik W", "last_name": "Born" } ], "year": 2003, "source": "Oryx", "identifiers": { "pmid": "20535730", "issn": "00306053", "doi": "10.1017/S0030605303250663", "isbn": "2831709598" }, "abstract": "..." } ] </code></pre> <pre><code class="highlight python">page = mendeley.catalog.search('polar bears').list() for doc in page.items: print doc.title </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> Retrieve documents which match general query terms. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/search/catalog</code> <h3 id="url-parameters">URL Parameters</h3> The search query is considered to be a string of terms separated by spaces. The search will return documents which match any of these, but rank those which match many terms higher than those which only match a few. <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>query</td> <td>string</td> <td>Query terms, which match any field in the document, e.g. title, author etc (required).</td> </tr> <tr> <td>view</td> <td>string</td> <td>Request additional fields in the documents returned, as for <a href="#catalog-documents">Catalog Documents</a>.</td> </tr> </tbody></table> <h2 id="advanced-search">Advanced search</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/search/catalog?source=polar+bears&limit=3' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' [ { "id": "dd18e5ad-74d0-3bfa-a5da-84640ad82976", "title": "Behavior", "type": "book_section", "authors": [ { "first_name": "I", "last_name": "Stirling" } ], "year": 1988, "source": "Polar Bears", "abstract": "Our understanding of the behavior of any animal comes from many sources of information..." }, { "id": "e807b6ff-1726-358a-9ec1-2768abe0936e", "title": "New data on the winter ecology of the polar bear (Ursus maritimus Phipps) on the Vrangel Island", "type": "journal", "authors": [ { "first_name": "a a", "last_name": "Kishchinskij" }, { "first_name": "S M", "last_name": "Uspenskij" } ], "year": 1973, "source": "Ecology and morphology of the polar bear.", "abstract": "Winter ecology of the polar bear was studied in March-April of 1969 and 1970..." }, { "id": "a9ee415c-7e8d-3d96-84d8-eb2b6d88cd65", "title": "Uncertainty in climate model projections of Arctic sea ice decline: an evaluation relevant to polar bears", "type": "report", "authors": [ { "first_name": "E T", "last_name": "DeWeaver" } ], "year": 2007, "source": "USGS Science Strategy to Support U.S. Fish and Wildlife Service Polar Bear Listing Decision.", "abstract": "This report describes uncertainties in climate model simulations of Arctic sea ice decline, and proposes a selection criterion for models to be used in projecting polar bear (Ursus maritimus) habitat loss..." } ] </code></pre> <pre><code class="highlight python">page = mendeley.catalog.advanced_search(source='polar bears').list() for doc in page.items: print doc.title </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> Retrieve documents which match the supplied values in specific fields. <h3 id="http-request">HTTP Request</h3> Advanced search uses the same endpoint as search by query: <code class="prettyprint">GET https://api.mendeley.com/search/catalog</code> <h3 id="url-parameters">URL Parameters</h3> Multiple search fields may be specified. At least one of <code class="prettyprint">title</code>, <code class="prettyprint">author</code>, <code class="prettyprint">source</code> or <code class="prettyprint">abstract</code> must be provided. If more than one of these is set, the results will return documents which match any of these, but rank those which match several fields higher than those which match fewer fields. <code class="prettyprint">min_year</code>, <code class="prettyprint">max_year</code> and <code class="prettyprint">open_access</code> act as filters. Setting either a minimum or maximum year excludes documents which do not have a year defined. <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>title</td> <td>string</td> <td>Matches terms in the title of the document.</td> </tr> <tr> <td>author</td> <td>string</td> <td>Matches the names of one or more authors.</td> </tr> <tr> <td>source</td> <td>string</td> <td>Matches the publication name.</td> </tr> <tr> <td>abstract</td> <td>string</td> <td>Matches terms in the abstract.</td> </tr> <tr> <td>min_year</td> <td>integer</td> <td>The earliest publication year to return results for.</td> </tr> <tr> <td>max_year</td> <td>integer</td> <td>The latest publication year to return results for.</td> </tr> <tr> <td>open_access</td> <td>boolean</td> <td>Specify true to limit results to open access publications (default = false).</td> </tr> <tr> <td>view</td> <td>string</td> <td>Request additional fields in documents returned, as for <a href="#catalog-documents">Catalog Documents</a>.</td> </tr> </tbody></table> <h1 id="datasets">Datasets</h1> <h2 id="public-dataset-attributes">Public dataset attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>The unique identifier for the dataset (required for other operations).</td> </tr> <tr> <td>version</td> <td>integer</td> <td>The version number of the dataset.</td> </tr> <tr> <td>name</td> <td>string</td> <td>The name of the dataset.</td> </tr> <tr> <td>description</td> <td>string</td> <td>A description of the data (files) contained in the dataset.</td> </tr> <tr> <td>publish_date</td> <td>string</td> <td>The date that this dataset version was made public. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>files</td> <td>array</td> <td>The dataset files, as <a href="#dataset-file-attributes">file objects</a>.</td> </tr> <tr> <td>categories</td> <td>array</td> <td>The categories that this dataset belongs to, as <a href="#category-attributes">category objects</a>.</td> </tr> <tr> <td>contributors</td> <td>array</td> <td>The contributors of the dataset, as <a href="#contributor-attributes">contributor objects</a>.</td> </tr> <tr> <td>doi</td> <td>object</td> <td>The DOI associated with the dataset, as <a href="#doi-attributes">DOI object</a>.</td> </tr> <tr> <td>versions</td> <td>array</td> <td>All versions of this dataset, as <a href="#version-attributes">version objects</a>.</td> </tr> <tr> <td>data_licence</td> <td>object</td> <td>The licence that applies to this dataset version, as <a href="#data-licence-attributes">data licence object</a>.</td> </tr> <tr> <td>articles</td> <td>array</td> <td>Journal articles associated with the dataset, <a href="#article-attributes">article objects</a>.</td> </tr> </tbody></table> <div id="dataset-file-attributes"></div> <h3 id="file-attributes">File attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>filename</td> <td>string</td> <td>The file’s filename</td> </tr> <tr> <td>name</td> <td>string</td> <td>A friendly name for the file</td> </tr> <tr> <td>content_details</td> <td>object</td> <td>Immutable metadata about the file, as a <a href="#file-content-details-attributes">content details object</a></td> </tr> </tbody></table> <h3 id="file-content-details-attributes">File content details attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>File ID</td> </tr> <tr> <td>sha256_hash</td> <td>string</td> <td>An SHA256 checksum for the file</td> </tr> <tr> <td>content_type</td> <td>string</td> <td>The file’s content type</td> </tr> <tr> <td>size</td> <td>number</td> <td>The file’s size in bytes</td> </tr> <tr> <td>created_date</td> <td>string</td> <td>The date the file was uploaded. This date is represented in ISO 8601 format</td> </tr> <tr> <td>status</td> <td>string</td> <td>The current status of the file object (claimed, unclaimed, not_uploaded)</td> </tr> <tr> <td>download_url</td> <td>string</td> <td>The URL where the file can be downloaded. Sets the <code class="prettyprint">content-disposition: attachment; filename=</code> using the parent file’s filename attribute</td> </tr> <tr> <td>download_expiry_time</td> <td>string</td> <td>The time that the download URL will expire</td> </tr> <tr> <td>view_url</td> <td>string</td> <td>Sets <code class="prettyprint">content-disposition: inline</code></td> </tr> </tbody></table> <h3 id="category-attributes">Category attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Category ID</td> </tr> <tr> <td>label</td> <td>string</td> <td>The label to display for the category</td> </tr> </tbody></table> The following categories are currently available: <table><thead> <tr> <th>id</th> <th>label</th> </tr> </thead><tbody> <tr> <td>http://data.elsevier.com/vocabulary/OmniScience/Concept-170589324</td> <td>Applied Sciences</td> </tr> <tr> <td>http://data.elsevier.com/vocabulary/OmniScience/Concept-170589320</td> <td>Arts and Humanities</td> </tr> <tr> <td>http://data.elsevier.com/vocabulary/OmniScience/Concept-186201601</td> <td>Health Sciences</td> </tr> <tr> <td>http://data.elsevier.com/vocabulary/OmniScience/Concept-170589436</td> <td>Mathematics</td> </tr> <tr> <td>http://data.elsevier.com/vocabulary/OmniScience/Concept-170589326</td> <td>Natural Sciences</td> </tr> <tr> <td>http://data.elsevier.com/vocabulary/OmniScience/Concept-170589328</td> <td>Social Sciences</td> </tr> </tbody></table> <h3 id="contributor-attributes">Contributor attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Mendeley Profile ID (optional)</td> </tr> <tr> <td>first_name</td> <td>string</td> <td>The contributor’s first name</td> </tr> <tr> <td>last_name</td> <td>string</td> <td>The contributor’s last name</td> </tr> <tr> <td>email</td> <td>string</td> <td>The contributor’s email address (this attribute is not included in public datasets)</td> </tr> <tr> <td>contribution</td> <td>string</td> <td>The contribution of this contributor</td> </tr> <tr> <td>institution</td> <td>object</td> <td>Optional, the institution that the contributor belongs to. Contains id (optional), name</td> </tr> </tbody></table> <h3 id="doi-attributes">DOI attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>ID of this DOI</td> </tr> <tr> <td>status</td> <td>string</td> <td>Status of the DOI. One of r<code class="prettyprint">equested</code> or <code class="prettyprint">allocated</code> for public datasets or <code class="prettyprint">reservered</code> for draft datasets</td> </tr> </tbody></table> <h3 id="version-attributes">Version attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>version</td> <td>string</td> <td>The version number</td> </tr> <tr> <td>publish_date</td> <td>string</td> <td>The date that this dataset version was made public. This date is represented in ISO 8601 format</td> </tr> <tr> <td>available</td> <td>string</td> <td>Whether this version is available (true, false)</td> </tr> </tbody></table> <h3 id="data-licence-attributes">Data licence attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>The ID of this licence type</td> </tr> <tr> <td>short_name</td> <td>string</td> <td>Friendly name of this licence</td> </tr> <tr> <td>full_name</td> <td>string</td> <td>Full legal name of this licence</td> </tr> <tr> <td>description</td> <td>string</td> <td>Description of this licence’s details</td> </tr> <tr> <td>url</td> <td>string</td> <td>URL of licence definition</td> </tr> </tbody></table> <h3 id="article-attributes">Article attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Article ID</td> </tr> <tr> <td>title</td> <td>string</td> <td>The articles’s title</td> </tr> <tr> <td>doi</td> <td>string</td> <td>The Digital Object Identifier for the article</td> </tr> <tr> <td>journal_id</td> <td>string</td> <td>The ID of the <a href="#journal-attributes">journal</a> this article is published in</td> </tr> </tbody></table> <h3 id="journal-attributes">Journal attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Journal ID</td> </tr> <tr> <td>name</td> <td>string</td> <td>The journal’s name</td> </tr> <tr> <td>url</td> <td>string</td> <td>The journal’s home URL</td> </tr> <tr> <td>logo_url</td> <td>string</td> <td>A URL to the journal’s logo</td> </tr> </tbody></table> <h2 id="draft-dataset-attributes">Draft dataset attributes</h2> Draft dataset objects are similar to public dataset objects. They have some additional properties to help manage access to unpublished datasets. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>The unique identifier for the dataset (required for other operations).</td> </tr> <tr> <td>name</td> <td>string</td> <td>The name of the dataset.</td> </tr> <tr> <td>description</td> <td>string</td> <td>A description of the data (files) contained in the dataset.</td> </tr> <tr> <td>files</td> <td>array</td> <td>The dataset files, as <a href="#dataset-file-attributes">file objects</a>.</td> </tr> <tr> <td>categories</td> <td>array</td> <td>The dataset categories, as <a href="#category-attributes">category objects</a>.</td> </tr> <tr> <td>contributors</td> <td>array</td> <td>The contributors of the dataset, as <a href="#contributor-attributes">contributor objects</a>.</td> </tr> <tr> <td>doi</td> <td>object</td> <td>The DOI associated with the dataset, as <a href="#doi-attributes">DOI object</a>.</td> </tr> <tr> <td>versions</td> <td>array</td> <td>All versions of this dataset, as <a href="#version-attributes">version objects</a>.</td> </tr> <tr> <td>data_licence</td> <td>object</td> <td>The licence that applies to this dataset version, as <a href="#data-licence-attributes">data licence object</a>.</td> </tr> <tr> <td>articles</td> <td>array</td> <td>Journal articles associated with the dataset, <a href="#article-attributes">article objects</a>.</td> </tr> <tr> <td>owner_id</td> <td>string</td> <td>ID of dataset owner</td> </tr> <tr> <td>created_data</td> <td>string</td> <td>Date that this dataset was created. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>last_modification_date</td> <td>string</td> <td>Date that this dataset was last modified. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>access_code</td> <td>string</td> <td>This will allow anyone to see the dataset if provided.</td> </tr> <tr> <td>permissions</td> <td>array</td> <td>Permission IDs applied to this draft</td> </tr> </tbody></table> <h2 id="submission-attributes">Submission attributes</h2> Submissions are a way for submission systems to add datasets (draft) related to the article submissions. Submissions and their data is only available to submission system and the authors associated with it. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>The unique (among the submission system) identifier for the submission (submission id) (required for other operations).</td> </tr> <tr> <td>owner</td> <td>object</td> <td>Article author information as <a href="#owner-attributes">owner object</a>.</td> </tr> <tr> <td>submission_data</td> <td>string</td> <td>Submission system specific data in a form of JSON object</td> </tr> <tr> <td>submission_token</td> <td>string</td> <td>A token generated when submission is created. It can later be used by other API clients (on behalf of the journal author) to add, modify and unlink datasets.</td> </tr> <tr> <td>datasets</td> <td>array</td> <td>datasets, associated with submission, as objects with “id” and “version” properties of the draft datasets.</td> </tr> </tbody></table> <h2 id="owner-attributes">Owner attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>email</td> <td>string</td> <td>The article author’s email address.</td> </tr> </tbody></table> <h2 id="specifying-fields-to-return">Specifying fields to return</h2> By default, only the id will be returned for requests. You should specify which attributes to return using the <code class="prettyprint">fields</code> query paramenter. For example, to return a list of datasets with the <code class="prettyprint">id</code>, <code class="prettyprint">version</code>, <code class="prettyprint">title</code>, <code class="prettyprint">description</code> and the <code class="prettyprint">mime_type</code> for <code class="prettyprint">files</code>, you would provide: <code class="prettyprint">GET /datasets?fields=results.id,results.version,results.name,results.description,results.files.mime_type</code> For nested objects such as contributors, you must provide the keys within the object. For example, to return a list of datasets, each with contributors’ <code class="prettyprint">first_name</code> and <code class="prettyprint">last_name</code> you would provide: <code class="prettyprint">GET /datasets?fields=results.contributors.first_name,results.contributors.last_name</code> If you want to receive all fields, you can pass <code class="prettyprint">*</code> to the fields parameter. Be aware that this query may take longer to receive and you may want to avoid using this in production. <code class="prettyprint">GET /datasets?fields=*</code> <h2 id="retrieving-datasets-(public)">Retrieving datasets (public)</h2> <h3 id="retrieve-datasets-with-the-id,-name,-description-and-version-fields">Retrieve datasets with the id, name, description and version fields</h3> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets?fields=results.id,results.name,results.description,results.version' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-public-dataset.1+json' \ { "results": [ { "id": "r4xggzrjxm", "version": 1, "name": "Test dataset", "description": "Test description" }, { "id": "xrnfvfkzkg", "version": 1, "name": "Another dataset", "description": "Test description" } ] } </code></pre> <h3 id="retrieve-datasets-with-the-id,-name,-description,-version-and-contributors-first_name-and-last_name-fields">Retrieve datasets with the id, name, description, version and contributors first_name and last_name fields</h3> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets?fields=results.id,results.name,results.description,results.version,results.contributors.first_name,results.contributors.last_name' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-public-dataset.1+json' \ { "results": [ { "id": "r4xggzrjxm", "version": 1, "name": "Example dataset", "description": "Test description", "contributors": [{ "first_name": "Dorian", "last_name": "Weimann" }] }, { "id": "xrnfvfkzkg", "version": 1, "name": "Another dataset", "description": "Test description", "contributors": [{ "first_name": "Barry", "last_name": "Tester" }] } ] } </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/datasets</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>article_doi</td> <td>string</td> <td>Filter by datasets linked to an article doi (optional)</td> </tr> <tr> <td>limit</td> <td>string</td> <td>The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500</td> </tr> <tr> <td>order</td> <td>string</td> <td>The sort order</td> </tr> <tr> <td>fields</td> <td>string</td> <td>A comma separated list of fields to return in the response.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a paginated list of public datasets. <h2 id="retrieving-a-dataset-(public)">Retrieving a dataset (public)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/856xgy2hy9' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-public-dataset.1+json' \ { "id": "4c35399a-1c2e-42eb-baed-3dc5281141e3", "version": 2, "versions": [ { "version": 2, "publish_date": "2015-12-15T10:34:34.897Z", "available": true }, { "version": 1, "publish_date": "2015-12-15T10:34:34.897Z", "available": true } ], "collaborators": [], "name": "Example dataset", "description": "Description of the data", "contributors": [{ "id": "c4676e62-10c3-3efe-b494-2f2dcec084c7", "first_name": "Barry", "last_name": "Tester" }, { "id": "eb0429bd-6f79-30b1-81b8-2855f457f380", "first_name": "Dorian", "last_name": "Weimann" }] "publish_date": "2015-12-15T10:34:34.897Z", "doi": { "id": "10.17632/856xgy2hy9.2", "status": "allocated" }, "short_id": "856xgy2hy9", "data_licence": { "short_name": "CC BY 4.0", "full_name": "Creative Commons Attribution 4.0 International", "description": "Unless indicated otherwise, you can share, copy and modify the images or other third party...", "url": "http://creativecommons.org/licenses/by/4.0" } } </code></pre> Retrieves a public dataset for the provided dataset ID <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/datasets/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>version</td> <td>string</td> <td>Specify a version other than the latest</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a paginated list of public datasets. <h2 id="retrieving-datasets-(draft)">Retrieving datasets (draft)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts?roles=owner&fields=id,version,name,description' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ [ { "id": "mp98hktrwp", "version": 1, "name": "Test dataset", "description": "Test description" } ] </code></pre> Returns a list of draft datasets where the user is the owner. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/datasets/drafts</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>roles</td> <td>string</td> <td>Comma delimited list of any roles the user should have on a dataset. Can include owner, author, collaborator.</td> </tr> <tr> <td>limit</td> <td>string</td> <td>The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500</td> </tr> <tr> <td>order</td> <td>string</td> <td>The sort order</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a paginated list of draft datasets. <h2 id="retrieving-a-dataset-(draft)">Retrieving a dataset (draft)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts/{id}' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ { "id": "jynm7bxcyb", "name": "A dataset", "description": "Description of my dataset", "owner_id": "34851d06-9994-3732-ad14-b283e037c04c", "version": 1, "versions": [ { "version": 1, "available": true } ], "last_modification_date": "2015-12-15T10:34:34.897Z", "data_licence": { "id": "01d9c749-3c4d-4431-9df3-620b2dcfe144", "short_name": "CC BY 4.0", "full_name": "Creative Commons Attribution 4.0 International", "description": "Unless indicated otherwise, you can share, copy and modify...", "url": "http://creativecommons.org/licenses/by/4.0" }, "access_code": "2d67e8e2-3d77-416e-9c1b-82bde731f4e5", "contributors": [{ "id": "34851d06-9994-3732-ad14-b283e037c04c", "first_name": "Barry", "last_name": "Tester", "email": "barry.tester@mendeley.com", "corresponding_author": false }], "collaborators": [], "all_versions": [], "files": [{ "id": "869290bb-0c47-43fc-ad83-44167f7316a7", "filename": "mugs.jpg", "name": "mugs", "file_size": 94839, "hash": "cac511c0aa8eaf77c763bda2c2110121d055d2c3ab60d7339434b487bc2f13ef", "last_modification_date": "2015-12-15T10:34:34.897Z", "mime_type": "image/jpeg", "created_date": "2015-12-15T10:34:34.897Z" }], "articles": [], "roles": ["owner", "author"], "permissions": ["Read", "ReadAccessCode", "ReadAuthorEmailAddresses", "ReadCollaborators", "Update", "Publish"] } </code></pre> Retrieves the draft dataset for the provided dataset ID <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/datasets/drafts/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>access_code</td> <td>string</td> <td>Provides access to users other than the owner (optional)</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a paginated list of public datasets. <h2 id="creating-a-dataset-(draft)">Creating a dataset (draft)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-dataset-creation-request.1+json' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ --data-binary $'{"name": "Test dataset", "description": "Test description", "contributors": [{"first_name": "Dorian", "last_name": "Weimann", "email": "example@email.com"}]}' { "id": "mp98hktrwp", "version": 1, "versions": [ { "version": 1, "available": true } ], "name": "Test dataset", "description": "Test description", "contributors": [ { "first_name": "Dorian", "last_name": "Weimann", "email": "example@email.com" } ], "files": [], "categories": [ { "id": "http://data.elsevier.com/vocabulary/OmniScience/Concept-170589324" } ], "roles": [ "owner", "author" ], "last_modification_date": "2015-12-15T10:34:34.897Z", "doi": { "id": "10.4124/mp98hktrwP.1", "status": "reserved" } } </code></pre> Returns a draft dataset. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/datasets/drafts</code> <h3 id="returns">Returns</h3> A 201 CREATED response containing a draft dataset. <h2 id="updating-a-dataset-(draft)">Updating a dataset (draft)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts/mp98hktrwp' \ -X PATCH \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-dataset-patch.1+json' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ --data-binary $'{"name": "Updated dataset"}' { "id": "mp98hktrwp", "version": 1, "versions": [ { "version": 1, "available": true } ], "name": "Updated dataset", "description": "Test description", "contributors": [ { "first_name": "Dorian", "last_name": "Weimann", "email": "example@email.com" } ], "files": [], "roles": [ "owner", "author" ], "last_modification_date": "2015-12-15T10:34:34.897Z", "doi": { "id": "10.4124/mp98hktrwP.1", "status": "reserved" } } </code></pre> Returns a draft dataset. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/datasets/drafts/{id}</code> <h3 id="returns">Returns</h3> A 200 OK response containing a draft dataset. <h2 id="adding-a-file-to-a-draft-dataset">Adding a file to a draft dataset</h2> You will first need to upload the file content to the <a href="#file-content">file content endpoint</a>. Now, with the returned <code class="prettyprint">id</code>, you can send it as the <code class="prettyprint">content_details.id</code> for the file. <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts/mp98hktrwp' \ -X PATCH \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-dataset-patch.1+json' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ --data-binary $'{"content_details": {"id": "3f2f968f-553b-467d-8121-ba02cab937a0"}, "filename": "my-file.pdf", "description": "Example decription"}' { "id": "mp98hktrwp", "files": [ { "filename": "my-file.pdf", "description": "Example Description", "content_details": { "id": "3f2f968f-553b-467d-8121-ba02cab937a0", "sha256_hash": "3fc0992551a40279346de32e6deb8bce0ca75d32a07c71451473bc024a400840", "content_type": "image/jpeg", "size": 141714, "created_date": "2015-12-15T10:34:34.897Z", "download_url": "https://downloads.mendeley.com/3fc0992551a40279346de32e6deb8bce0ca75d32a07c71451473bc024a400840", "download_expiry_time": 1445343439786 } } ], ... } </code></pre> Returns a draft dataset. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/datasets/drafts/{id}</code> <h3 id="returns">Returns</h3> A 200 OK response containing a draft dataset. <h2 id="publishing-a-dataset-(draft)">Publishing a dataset (draft)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts/{id}' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-draft-dataset.1+json' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ --data-binary $'{"name": "Test dataset", "description": "Test description", "contributors": [{"first_name": "Dorian", "last_name": "Weimann", "email": "example@email.com"}]}' { "id": "mp98hktrwp", "version": 1, "versions": [ { "version": 1, "available": true } ], "name": "Test dataset", "description": "Test description", "contributors": [ { "first_name": "Dorian", "last_name": "Weimann", "email": "example@email.com" } ], "files": [ { "filename": "my-file.pdf", "description": "Example Description", "content_details": { "id": "3f2f968f-553b-467d-8121-ba02cab937a0", "sha256_hash": "3fc0992551a40279346de32e6deb8bce0ca75d32a07c71451473bc024a400840", "content_type": "image/jpeg", "size": 141714, "created_date": "2015-12-15T10:34:34.897Z", "download_url": "https://downloads.mendeley.com/3fc0992551a40279346de32e6deb8bce0ca75d32a07c71451473bc024a400840", "download_expiry_time": 1445343439786 } } ], "roles": [ "owner", "author" ], "last_modification_date": "2015-12-15T10:34:34.897Z", "doi": { "id": "10.4124/mp98hktrwP.1", "status": "reserved" } } </code></pre> Publishes a draft as the next sequential version <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/datasets/drafts/{id}</code> <h3 id="returns">Returns</h3> A 200 OK response containing the published dataset. <h2 id="deleting-a-dataset-(draft)">Deleting a dataset (draft)</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts/mp98hktrwp' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ </code></pre> Permanently deletes a draft dataset. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE https://api.mendeley.com/datasets/drafts/{id}</code> <h3 id="returns">Returns</h3> A 204 No Content response. <h2 id="creating-a-submission">Creating a submission</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/submissions/{submission_system}' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-rdm-submission-creation-request.1+json' \ -H 'Accept: application/vnd.mendeley-rdm-submission.1+json' \ --data-binary $'{ "id": "b3zdUk4s", "owner": { "email": "example@email.com" }, "submission_data": { "title": "Test title", "authors": [ ] }}' { "id": "b3zdUk4s", "owner": { "email": "example@email.com" }, "submission_data": { "title": "Test title", "authors": [] }, "submission_token": "628e0343-5de5-4955-a64f-2637f675bd6e", "datasets": [] } </code></pre> Returns created submission. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/datasets/submissions/{submission_system}</code> <h3 id="returns">Returns</h3> A 201 Created response containing a submission. <h2 id="updating-a-submission">Updating a submission</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/drafts/mp98hktrwp' \ -X PATCH \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-rdm-submission-modification-request.1+json' \ -H 'Accept: application/vnd.mendeley-rdm-submission.1+json' \ --data-binary $'{ "id": "b3zdUk4s", "owner": { "email": "example@email.com"}, "submission_data": { "title": "Test title", "authors": [ { "first_name": "Example", "last_name": "Author", "email": "example@email.com", "webuser_id": "1234-1234-1234-1234"} ]} }' { "id": "b3zdUk4s2", "owner": { "email": "example@email.com" }, "submission_data": { "title": "Test title", "authors": [ { "first_name": "Example", "last_name": "Author", "email": "example@email.com", "webuser_id": "1234-1234-1234-1234" } ] }, "submission_token": "628e0343-5de5-4955-a64f-2637f675bd6e", "datasets": [] } </code></pre> Returns a modified submission. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH /datasets/submissions/{submission_system}/{id}</code> <h3 id="returns">Returns</h3> A 201 Created response containing a submission. <h2 id="adding-dataset-to-submission">Adding dataset to submission</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/submissions/{submission_system}/{id}/datasets?submission_token={submission_token}' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-dataset-creation-request.1+json' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' \ --data-binary $'{ "description": "Some description goes here", "files": [ { "filename": "test.txt", "content_details": { "id": "883487f3-9bfe-4e44-9cc4-705fec68913a"} }] } ' { "related_links": [], "id": "6gz33fkcs7", "doi": { "id": "10.4124/6gz33fkcs7.1", "status": "reserved" }, "description": "Some description goes here", "owner": { "email": "example@email.com" }, "version": 1, "created_date": "2016-07-28T07:27:51.492Z", "last_modification_date": "2016-07-28T07:27:51.492Z", "view_token": "dc0c279a-dd71-4a48-8d96-62fbf58558aa", "contributors": [], "versions": [], "files": [ { "filename": "test.txt", "content_details": { "id": "883487f3-9bfe-4e44-9cc4-705fec68913a", "sha256_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", "sha1_hash": "da39a3ee5e6b4b0d3255bfef95601890afd80709", "content_type": "text/plain", "size": 0, "created_date": "2016-05-18T00:00:00.000Z", "download_url": {download url}, "view_url": {download url}, "download_expiry_time": "2016-07-28T08:27:52.226Z" } } ], "articles": [], "permissions": [ "read_dataset", "read_view_token", "read_contributor_email_addresses", "update_dataset", "publish_dataset", "delete_draft" ], "categories": [], "institutions": [] } </code></pre> Returns created submission’s dataset. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST /datasets/submissions/{submission_system}/{id}/datasets?submission_token={submission_token}</code> <h3 id="returns">Returns</h3> A 201 Created response containing a dataset. <h2 id="getting-datasets-associated-with-submission">Getting datasets associated with submission</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/submissions/{submission_system}/{id}/datasets?fields=id,version,description&submission_token={submission_token}' \ -X GET \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-draft-dataset.1+json' [ { "id": "6gz33fkcs7", "description": "Some description goes here", "version": 1 } ] </code></pre> Returns datasets associated with submission. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET /datasets/submissions/{submission_system}/{id}/datasets?fields=id,version,description&submission_token={submission_token}</code> <h3 id="returns">Returns</h3> A 200 Ok response containing a datasets. <h2 id="unlinking-dataset-from-submission">Unlinking dataset from submission</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/datasets/submissions/{submission_system}/{id}/datasets/{dataset_id}?submission_token={submission_token}' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE https://api.mendeley.com/datasets/submissions/{submission_system}/{id}/datasets/{dataset_id}?submission_token={submission_token}</code> <h3 id="returns">Returns</h3> A 204 No Content response. <h1 id="disciplines">Disciplines</h1> <h2 id="retrieve-all-disciplines">Retrieve all disciplines</h2> Retrieves all disciplines and possible sub-disciplines. Sample JSON is abbreviated below to the top 3 disciplines. <pre><code class="highlight shell">curl 'https://api.mendeley.com/disciplines' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-discipline.1+json' [ { "name": "Arts and Literature", "subdisciplines": [ "Architecture", "Art History", "Children's Literature", "Culture Heritage", "Film and TV Studies", "Folklore", "Latin", "Literature", "Miscellaneous", "Music", "Visual and Performing Arts" ] }, { "name": "Astronomy / Astrophysics / Space Science", "subdisciplines": [ "Celestial Mechanics", "Cosmology", "Extragalactic Astronomy", "Interstellar Matter", "Meteors", "Miscellaneous", "Solar Terrestrial Physics", "Stars", "The Sun", "Theoretical Astrophysics" ] }, { "name": "Biological Sciences", "subdisciplines": [ "Agricultural Science", "Algology", "Animal Behavior", "Animal Physiology", "Biochemistry", "Bioinformatics", "Biometry", "Biophysics", "Biotechnology", "Botany", "Cellular Biology", "Embryology", "Entomology", "Food Science and Technology", "Forestry Science", "Genetics", "Hydrobiology", "Ichthyology", "Immunology", "Limnology", "Marine Biology", "Microbiology", "Microscopy", "Miscellaneous", "Molecular Biology", "Mycology", "Neurobiology", "Ornithology", "Parasitology", "Plant Sciences", "Soil Sciences", "Veterinary Science", "Virology", "Zoology and Animal Science" ] } ] .... .... </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/disciplines</code> <h3 id="returns">Returns</h3> A 200 OK response containing a all disciplines and subdisciplines in Mendeley. <h1 id="documents">Documents</h1> <h2 id="core-document-attributes">Core document attributes</h2> The following attributes are returned by default. Some string attributes have a maximum length - these are indicated in the table below. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td></td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> <tr> <td>title</td> <td>string</td> <td>500</td> <td>Title of the document. This is a required field.</td> </tr> <tr> <td>type</td> <td>string</td> <td></td> <td>The type of the document. Supported types: journal, book, generic, book_section, conference_proceedings, working_paper, report, web_page, thesis, magazine_article, statute, patent, newspaper_article, computer_program, hearing, television_broadcast, encyclopedia_article, case, film, bill.</td> </tr> <tr> <td>profile_id</td> <td>string</td> <td></td> <td>Profile id (UUID) of the Mendeley user that added the document to the system.</td> </tr> <tr> <td>group_id</td> <td>string</td> <td></td> <td>Group id (UUID) that the document belongs to.</td> </tr> <tr> <td>created</td> <td>string</td> <td></td> <td>Date the document was added to the system. This date is set by the server after a successful create request. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>last_modified</td> <td>string</td> <td></td> <td>Date in which the document was last modified. This date is set by the server after a successful update request. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>abstract</td> <td>string</td> <td>10,000</td> <td>Brief summary of the document.</td> </tr> <tr> <td>source</td> <td>string</td> <td>255</td> <td>Publication outlet, i.e. where the document was published.</td> </tr> <tr> <td>year</td> <td>integer</td> <td></td> <td>Year in which the document was issued/published.</td> </tr> <tr> <td>authors</td> <td>array</td> <td></td> <td>List of authors of the document, as <a href="#people">person</a> objects.</td> </tr> <tr> <td>identifiers</td> <td>object</td> <td>500 each</td> <td>List of identifiers available for the document. The supported identifiers are: arxiv, doi, isbn, issn, pmid (PubMed), scopus and ssrn.</td> </tr> <tr> <td>keywords</td> <td>array</td> <td>300 each</td> <td>List of author-supplied keywords for the document.</td> </tr> </tbody></table> <h2 id="additional-document-attributes">Additional document attributes</h2> The following attributes are available using a <a href="#document-views">view</a>. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>month</td> <td>integer</td> <td></td> <td>Month in which the document was issued/published. This should be an integer between 1 and 12.</td> </tr> <tr> <td>day</td> <td>integer</td> <td></td> <td>Day in which the document was issued/published. This should be an integer between 1 and 31.</td> </tr> <tr> <td>revision</td> <td>string</td> <td>255</td> <td>Number identifying the item (e.g. a report number).</td> </tr> <tr> <td>pages</td> <td>string</td> <td>50</td> <td>range of pages the document covers in the issue, e.g 4-8.</td> </tr> <tr> <td>volume</td> <td>string</td> <td>20</td> <td>volume holding the document, e.g “2” from journal volume 2.</td> </tr> <tr> <td>issue</td> <td>string</td> <td>255</td> <td>issue holding the document, e.g. “5” for a journal article from journal volume 2, issue 5</td> </tr> <tr> <td>websites</td> <td>array</td> <td>5000 total</td> <td>Where the document was accessed from.</td> </tr> <tr> <td>publisher</td> <td>string</td> <td>255</td> <td>Publisher of the document.</td> </tr> <tr> <td>city</td> <td>string</td> <td>255</td> <td>city where the document was published.</td> </tr> <tr> <td>edition</td> <td>array</td> <td>20</td> <td>edition holding the document, e.g. “3” from the third edition of a book.</td> </tr> <tr> <td>institution</td> <td>string</td> <td>255</td> <td>Institution in which the document was published.</td> </tr> <tr> <td>series</td> <td>string</td> <td>255</td> <td>title of the collection holding the document (e.g. the series title for a book)</td> </tr> <tr> <td>chapter</td> <td>string</td> <td>20</td> <td>Chapter number.</td> </tr> <tr> <td>editors</td> <td>array</td> <td></td> <td>List of editors of the document, as <a href="#people">person</a> objects.</td> </tr> <tr> <td>accessed</td> <td>string</td> <td></td> <td>Date that the document was accessed. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>tags</td> <td>array</td> <td>100 each</td> <td>List of user-supplied tags for the document.</td> </tr> <tr> <td>read</td> <td>boolean</td> <td></td> <td>Flag used to identify whether the document has been read or not.</td> </tr> <tr> <td>starred</td> <td>boolean</td> <td></td> <td>Flag used to identify whether the user has marked the document as favourite.</td> </tr> <tr> <td>authored</td> <td>boolean</td> <td></td> <td>Flag used to identify whether the user has authored the document.</td> </tr> <tr> <td>confirmed</td> <td>boolean</td> <td></td> <td>Flag to identify whether the metadata of the document is correct after it has been extracted from the PDF file.</td> </tr> <tr> <td>hidden</td> <td>boolean</td> <td></td> <td>Flag to identify whether Mendeley can publish this document to the Mendeley catalog.</td> </tr> <tr> <td>file_attached</td> <td>boolean</td> <td></td> <td>Flag to identify whether the document has a file attached. Files can be retrieved using the <a href="#files">files API</a>.</td> </tr> <tr> <td>citation_key</td> <td>string</td> <td>255</td> <td>Identifier used by BibTeX when citing documents.</td> </tr> <tr> <td>source_type</td> <td>string</td> <td>255</td> <td>Original type of a document imported from BibTeX.</td> </tr> <tr> <td>language</td> <td>string</td> <td>255</td> <td>Language of the document.</td> </tr> <tr> <td>short_title</td> <td>string</td> <td>50</td> <td>A short version of the title, used in some citations.</td> </tr> <tr> <td>reprint_edition</td> <td>string</td> <td>10</td> <td>Edition number of this reprint of the document.</td> </tr> <tr> <td>genre</td> <td>string</td> <td>255</td> <td>Class, type or genre of the document.</td> </tr> <tr> <td>country</td> <td>string</td> <td>255</td> <td>Country where the document was published.</td> </tr> <tr> <td>translators</td> <td>array</td> <td></td> <td>List of translators of the document, as <a href="#people">person</a> objects.</td> </tr> <tr> <td>series_editor</td> <td>string</td> <td>255</td> <td>Editor name for a book series.</td> </tr> <tr> <td>code</td> <td>string</td> <td>255</td> <td>Code for legal documents.</td> </tr> <tr> <td>medium</td> <td>string</td> <td>255</td> <td>Medium description (e.g. “CD”, “DVD”).</td> </tr> <tr> <td>user_context</td> <td>string</td> <td>255</td> <td>The format of the item (e.g. Journal)</td> </tr> <tr> <td>department</td> <td>string</td> <td>255</td> <td>University department name.</td> </tr> <tr> <td>patent_owner</td> <td>string</td> <td>255</td> <td>Name of patent assignee.</td> </tr> <tr> <td>patent_application_number</td> <td>string</td> <td>255</td> <td>Patent application number.</td> </tr> <tr> <td>patent_legal_status</td> <td>string</td> <td>255</td> <td>Legal status of document, example values “Restricted”, “Pending approval”, “Granted”.</td> </tr> </tbody></table> <h3 id="people">People</h3> People are represented as an object with the following attributes: <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>last_name</td> <td>string</td> <td>255</td> <td>Last name of the person. Required.</td> </tr> <tr> <td>first_name</td> <td>string</td> <td>255</td> <td>First name of the person.</td> </tr> </tbody></table> <h2 id="document-views">Document views</h2> To get additional fields, you can use one of the following views: <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>bib</td> <td>Will return the core fields plus the bibliographic data. This includes: pages, volume, issue, websites, month, publisher, day, city, edition, institution, series, chapter, revision, editors, accessed, citation_key, source_type, language, short_title, reprint_edition, genre, country, translators, series_editor, code, medium, user_context, department.</td> </tr> <tr> <td>client</td> <td>Will return the core fields plus the fields needed for clients to sync across different devices like read, starred, authored, confirmed, hidden and file_attached.</td> </tr> <tr> <td>tags</td> <td>Will return the core fields plus tags.</td> </tr> <tr> <td>patent</td> <td>Will return the core fields plus patent_owner, patent_application_number and patent_legal_status.</td> </tr> <tr> <td>all</td> <td>Will return all fields.</td> </tr> </tbody></table> <h2 id="retrieving-a-document">Retrieving a document</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents/cb58a7d9-8463-34e2-b1b8-457a3872ecdc' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' { "id": "cb58a7d9-8463-34e2-b1b8-457a3872ecdc", "title": "Linked Data - The Story So Far", "type": "journal", "authors": [ { "first_name": "Christian", "last_name": "Bizer" }, { "first_name": "Tom", "last_name": "Heath" }, { "first_name": "Tim", "last_name": "Berners-Lee" } ], "year": 2009, "source": "International Journal on Semantic Web and Information Systems", "identifiers": { "doi": "10.4018/jswis.2009081901", "issn": "15526283" }, "created": "2014-04-09T09:36:44.000Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "last_modified": "2014-04-09T09:36:44.000Z", "abstract": "The term Linked Data refers to a set of best practices for publishing and connecting structured data on the Web......." } </code></pre> <pre><code class="highlight python">doc = mendeley.documents.get('cb58a7d9-8463-34e2-b1b8-457a3872ecdc') print doc.title </code></pre> <pre><code class="highlight java">Document doc = sdk.getDocument("cb58a7d9-8463-34e2-b1b8-457a3872ecdc", View.ALL); </code></pre> Retrieves a document by ID. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/documents/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> <tr> <td>view</td> <td>string</td> <td>includes core document fields plus additional fields.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a single document. <h2 id="retrieving-documents">Retrieving documents</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' [ { "id": "b9a91b83-c091-3bd1-93b4-88b4a3123f8e", "title": "Differential synchronization", "type": "journal", "authors": [ { "first_name": "Igor", "last_name": "Žutić" } ], "year": 2009, "source": "Proceedings of the 9th ACM symposium on Document engineering - DocEng '09", "identifiers": { "isbn": "9781605585758", "doi": "10.1145/1600193.1600198" }, "created": "2013-10-21T11:47:18.000Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "last_modified": "2014-01-15T11:43:24.000Z" }, { "id": "2bf33ebd-7cd1-3786-903d-d74d04958e40", "title": "How to Design a Good API and Why it Matters", "type": "report", "authors": [ { "first_name": "Joshua", "last_name": "Bloch" } ], "year": 2006, "source": "Google Inc", "created": "2014-04-07T08:42:34.000Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "last_modified": "2014-04-08T10:11:41.000Z", "abstract": "In lieu of a traditional abstract, I’ve tried to distill the essence of the talk into a collection of maxims" } ] </code></pre> <pre><code class="highlight python">for doc in mendeley.documents.iter(): print doc.title </code></pre> <pre><code class="highlight java">DocumentList docList = sdk.getDocuments(); List<Document> docs = docList.documents; // Get subsequent pages: Page next = docList.next; while(next != null) { docList = sdk.getDcouments(next); docs.addAll(docList.documents); next = docList.next; } </code></pre> Retrieves a list of documents. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/documents</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>view</td> <td>string</td> <td>includes core document fields plus additional fields.</td> </tr> <tr> <td>profile_id</td> <td>string</td> <td>the id of the profile that the document belongs to, that does not belong to any group. If not supplied returns users documents.</td> </tr> <tr> <td>group_id</td> <td>string</td> <td>the id of the group that the document belongs to. If not supplied returns users documents.</td> </tr> <tr> <td>modified_since</td> <td>string</td> <td>returns only documents modified since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>deleted_since</td> <td>string</td> <td>returns only documents deleted since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500</td> </tr> <tr> <td>order</td> <td>string</td> <td>sort order</td> </tr> <tr> <td>sort</td> <td>string</td> <td>field to sort on</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A paginated list of documents. <h2 id="retrieving-a-bibtex-document">Retrieving a BiBTex document</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents/cb58a7d9-8463-34e2-b1b8-457a3872ecdc?view=bib' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/x-bibtex' @article{Armbrust2009, title = {Above the clouds: A Berkeley view of cloud computing}, year = {2009}, journal = { University of California, Berkeley, Tech. Rep. UCB }, author = {Armbrust, M and Fox, A and Griffith, R and Joseph, AD and RH}, pages = {07-013} </code></pre> <pre><code class="highlight python">coming soon </code></pre> <pre><code class="highlight java">Not implemented </code></pre> Retrieves a document in BiBTex format. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/documents/{id}?view=bib</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> <tr> <td>view</td> <td>string</td> <td>needs to be set to ‘bib’</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a single document in BiBTex format <h2 id="retrieving-bibtex-documents">Retrieving BiBTex documents</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents?view=bib' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/x-bibtex' @article{Mirashe2010, title = {Cloud Computing}, year = {2010}, journal = {Communications of the ACM}, author = {Mirashe, Shivaji P and Kalyankar, N V}, chapter = {6}, doi = {10.1145/358438.349303}, editor = {Antonopoulos, Nick and Gillam, Lee}, number = {7}, pages = {9}, series = {Informatik im Fokus}, volume = {51} } @misc{Ghemawat2003, title = {The Google file system}, year = {2003}, booktitle = {ACM SIGOPS Operating Systems Review}, author = {Ghemawat, Sanjay and Gobioff, Howard and Leung, Shun-Tak}, number = {5}, pages = {29}, volume = {37} } @article{Armbrust2009, title = {Above the clouds: A Berkeley view of cloud computing}, year = {2009}, journal = { University of California, Berkeley, Tech. Rep. UCB }, author = {Armbrust, M and Fox, A and Griffith, R and Joseph, AD and RH}, pages = {07-013} } @inproceedings{Chang2006, title = {Bigtable: A distributed storage system for structured data}, year = {2006}, booktitle = {7th Symposium on Operating Systems Design and Implementation (OSDI '06), November 6-8, Seattle, WA, USA}, author = {Chang, Fay and Dean, Jeffrey and Ghemawat, Sanjay and Hsieh, Wilson C. and Wallach, Deborah A. and Burrows, Mike and Chandra, Tushar and Fikes, Andrew and Gruber, Robert E.}, pages = {205-218} } </code></pre> <pre><code class="highlight python">coming soon </code></pre> <pre><code class="highlight java">Not implemented </code></pre> Retrieves multiple documents in BiBTex format. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/documents?view=bib</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>view</td> <td>string</td> <td>needs to be set to 'bib’</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A paginated list of BiBTex documents <h2 id="creating-a-document-from-metadata">Creating a document from metadata</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' \ -H 'Content-Type: application/vnd.mendeley-document.1+json' \ --data-binary $'{"type": "journal", "title": "How To Build a Mendeley API"}' { "id": "b3a561de-f317-3042-8a5e-0161e7b5fe1d", "title": "How To Build a Mendeley API", "type": "journal", "created": "2014-07-01T10:59:51.357Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "year": 2009, "source": "Molecular Cell", "title": "How To Choose a Good Scientific Problem", "identifiers": { "doi": "10.1016/j.molcel.2009.09.013", "issn": "10972765" }, "authors": [ { "first_name": "Uri", "last_name": "Alon" } ], "pages": "726-728", "volume": "35", "issue": "6" } </code></pre> <pre><code class="highlight python">doc = mendeley.documents.create(title='How To Choose a Good Scientific Problem', type='journal') print doc.id </code></pre> <pre><code class="highlight java">Document doc = Document.getBuilder("How To Choose a Good Scientific Problem", "journal").build(); Document created = sdk.postDocument(doc); String id = created.id; </code></pre> Creates a document. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/documents</code> <h3 id="returns">Returns</h3> After a successful create request, the server will return newly created object and a 201 response with the URL of the newly created resource available in the Location header. <h2 id="creating-a-document-from-a-file">Creating a document from a file</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/pdf' \ -H 'Content-Disposition: attachment; filename="example.pdf"' \ --data-binary @example.pdf </code></pre> <pre><code class="highlight python">document = mendeley.documents.create_from_file('example.pdf') </code></pre> Creates a document by extracting metadata from a supplied file. <h3 id="header-parameters">Header Parameters</h3> The following header parameters must be set. <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>Content-Type</td> <td>This header will tell the server the file’s media type. For example, application/pdf.</td> </tr> <tr> <td>Content-Disposition</td> <td>This header is used to extract the file’s name. The value should be, for example: attachment; filename=“example.pdf”</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> After a successful create request, the server will return newly created object and a 201 response with the URL of the newly created resource available in the Location header. <h2 id="updating-documents">Updating documents</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents/6e456c13-e850-3cf4-9f25-0d8307d36443' \ -X PATCH \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-document.1+json' \ --data-binary '{"type": "journal", "title": "How To Build an Awesome Mendeley API"}' </code></pre> <pre><code class="highlight python">updated_doc = doc.update(title='How To Build an Awesome Mendeley API') </code></pre> <pre><code class="highlight java">Document amendments = Document.getBuilder().setYear(2015).build(); sdk.patchDocument("6e456c13-e850-3cf4-9f25-0d8307d36443", null, Document amendments); </code></pre> Only the fields you pass in the request will be updated. You can clear a field by passing a null value for it. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/documents/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> </tbody></table> <h3 id="header-parameters">Header Parameters</h3> A client can put a precondition on the request using the <code class="prettyprint">If-Unmodified-Since</code> header e.g do not apply an update if the document was modified after this time. <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>If-Unmodified-Since</td> <td><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">RFC-2616</a></td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A successful update will return a HTTP 200 with the updated document. <h2 id="move-a-document-to-the-trash">Move a document to the trash</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents/6e456c13-e850-3cf4-9f25-0d8307d36443/trash' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight python">trashed_doc = doc.move_to_trash() </code></pre> <pre><code class="highlight java">sdk.trashDocument("6e456c13-e850-3cf4-9f25-0d8307d36443"); </code></pre> Moves a document to the trash. It can still be restored. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/documents/{id}/trash</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response. <h2 id="delete-a-document">Delete a document</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/documents/c9939b3f-eddd-33ab-8f2f-7337fcd5cf39' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight python">doc.delete() </code></pre> <pre><code class="highlight java">sdk.deleteDocument("c9939b3f-eddd-33ab-8f2f-7337fcd5cf39"); </code></pre> Permanently deletes a document. <code class="prettyprint">DELETE https://api.mendeley.com/documents/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response. <h2 id="retrieve-list-of-deleted-documents-ids">Retrieve list of deleted documents ids</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/deleted_documents' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-deleted-document.1+json' </code></pre> Retrieve a list of deleted documents ids. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/deleted_documents</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>since</td> <td>date</td> <td>Returns only documents deleted since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>group_id</td> <td>string</td> <td>Group ID (UUID). If not supplied, returns user documents</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing the ids of the deleted documents <h1 id="documents-metadata-lookup">Documents Metadata Lookup</h1> <h2 id="metadata-lookup">Metadata lookup</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/metadata?doi=10.1038%2F35095137' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document-lookup.1+json' { "catalog_id": "f5cc2417-a636-3c6a-9748-13aab2c2b35d", "score": 100 } </code></pre> <pre><code class="highlight python"> Coming soon </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> Finds the catalog_id with the best metadata for the provided data. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/metadata</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>arxiv</td> <td>string</td> <td><a href="http://uk.arxiv.org/help/arxiv_identifier">arXiv identifier </a></td> </tr> <tr> <td>doi</td> <td>string</td> <td><a href="http://uk.arxiv.org/help/arxiv_identifier">Digital Object Identifier </a></td> </tr> <tr> <td>pmid</td> <td>string</td> <td><a href="http://www.ncbi.nlm.nih.gov/pubmed">PubMed identifier</a></td> </tr> <tr> <td>title</td> <td>string</td> <td>Matches terms in the title of the document.</td> </tr> <tr> <td>filehash</td> <td>string</td> <td>Filehash of the file</td> </tr> <tr> <td>authors</td> <td>string</td> <td>Matches the names of one or more authors.</td> </tr> <tr> <td>year</td> <td>string</td> <td>Year of publication</td> </tr> <tr> <td>source</td> <td>string</td> <td>Matches the publication name.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> Returns the <code class="prettyprint">catalog_id</code> of the closest matching catalog document. The <code class="prettyprint">score</code> is a confidence indicator of the match with 100 being very confident. <h1 id="files">Files</h1> <h2 id="file-attributes">File attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>The unique identifier for the file (required for other operations).</td> </tr> <tr> <td>file_name</td> <td>string</td> <td>The name of the file. This is currently a generated name from the metadata of the document that the file is attached to. However, we will support original file names from the upload soon.</td> </tr> <tr> <td>mime_type</td> <td>string</td> <td>The mime type of the file. This is used to work out the extension of the file. More info on mime types <a href="http://en.wikipedia.org/wiki/Internet_media_type">here</a>.</td> </tr> <tr> <td>filehash</td> <td>string</td> <td>SHA1 hash of the file. This can be used to check the integrity of the file.</td> </tr> <tr> <td>document_id</td> <td>string</td> <td>The id of the document the file is attached to.</td> </tr> <tr> <td>size</td> <td>integer</td> <td>The size of the file, in bytes.</td> </tr> </tbody></table> <h2 id="retrieving-files">Retrieving files</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/files' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-file.1+json' [ { "id": "16bd4f6e-4578-3391-356d-66b374143457", "document_id": "183217fc-9c61-34d1-be8b-996556410ccb", "mime_type": "application/pdf", "file_name": "MapReduce", "filehash": "f22d97429926d433552174507586c1ff9df3cabd", "size": 383810 }, { "id": "14336272-ae94-1b83-2193-158c3f6afcef", "document_id": "3a691e84-8922-3de1-8819-53b85e54c559", "mime_type": "application/pdf", "file_name": "Inside Front Cover - Scope & Editors", "filehash": "12aa3051a009fa6e9ab5983e68b8fd3302b57690", "size": 42641 }, { "id": "2e0daf4b-bb2d-8979-0c1f-a7f44f456d29", "document_id": "99ff5452-0aab-333c-9c81-79329146c2fb", "mime_type": "application/pdf", "file_name": "MapReduce Online", "filehash": "6c577e7518c8dfcf472f3be7e5686d4bcbbc4c45", "size": 553896 } ] </code></pre> <pre><code class="highlight python">for file in mendeley.files.iter(): print file.filehash </code></pre> <pre><code class="highlight java">FileList fileList = sdk.getFiles(); List<File> files = fileList.files; Page next = fileList.next; </code></pre> Returns a list of files in your library. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/files</code> <h3 id="query-parameters">Query Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>document_id</td> <td>When this is provided, the response will contain only the files attached to that particular document.</td> <td></td> </tr> <tr> <td>group_id</td> <td>When this is provided, the response will contain only the files attached to documents that belong to that particular group.</td> <td></td> </tr> <tr> <td>added_since</td> <td>Response will only contain those files uploaded since the ‘added_since’ date. This date should be an ISO 8601 timestamp.</td> <td></td> </tr> <tr> <td>deleted_since</td> <td>Response will only contain those files deleted since this date. It should be an ISO 8601 timestamp.</td> <td></td> </tr> </tbody></table> <h2 id="downloading-a-file">Downloading a file</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/files/16bd4f6e-4578-3391-356d-66b374143457' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight python">path = doc.download_file('/tmp') </code></pre> <pre><code class="highlight java">MendeleySdk asyncSdk = MendeleySdkFactory.getInstance(); GetFileCallback getFileCallback = new GetFileCallback() { ... } asyncSdk.getFile("16bd4f6e-4578-3391-356d-66b374143457", "/sdcard", getFileCallback); </code></pre> Downloads a file. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET /files/{id}</code> <h3 id="returns">Returns</h3> On a successful request the server will respond with a 303 See Other response together with a Location header. The URL in this location header is signed for a limited period of time where the file can be downloaded. <h2 id="uploading-a-file">Uploading a file</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/files' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/pdf' \ -H 'Content-Disposition: attachment; filename="example.pdf"' \ -H 'Link: <https://api.mendeley.com/documents/cfb60e27-d3e4-397d-bb59-fc8388b98152>; rel="document"' \ --data-binary @example.pdf </code></pre> <pre><code class="highlight python">file = doc.attach_file('example.pdf') </code></pre> <pre><code class="highlight java">PostFileCallback postFileCallback = new PostFileCallback() { ... } asyncSdk.postFile("application/pdf", "cfb60e27-d3e4-397d-bb59-fc8388b98152", "/sdcard/example.pdf", postFileCallback); </code></pre> Uploads a file. <h3 id="header-parameters">Header Parameters</h3> The following header parameters must be set. <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>Content-Type</td> <td>This header will tell the server the file’s media type. For example, application/pdf.</td> </tr> <tr> <td>Content-Disposition</td> <td>This header is used to extract the file’s name. The value should be, for example: attachment; filename=“example.pdf”</td> </tr> <tr> <td>Link</td> <td>We use this header to specify the document that the file should be attached to. For example: https://api.mendeley.com/documents/cfb60e27-d3e4-397d-bb59-fc8388b98152</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A successful request will respond with a 201 Created code and a Location header where you can find the URL where you can download the file. <h2 id="linking-a-file-content-to-a-file">Linking a file content to a file</h2> Creates a file based on a file content ticket obtained from /file_contents endpoint <pre><code class="highlight shell">curl 'https://api.mendeley.com/files' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-file.1+json' \ -H 'Content-Disposition: attachment; filename="file.pdf"' \ -H 'Content-Type: application/vnd.mendeley-file-link.1+json' \ -H 'Link: <https://api.mendeley.com/documents/34542a05-ca31-3f25-9280-678e81a8a848>; rel="document"' \ --data-binary '{"file_content_ticket" : "<FILE_CONTENT_TICKET_ID>"}' </code></pre> <h3 id="header-parameters">Header Parameters</h3> The following header parameters must be set. <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>Accept</td> <td>application/vnd.mendeley-file.1+json</td> </tr> <tr> <td>Content-Type</td> <td>application/vnd.mendeley-file-link.1+json</td> </tr> <tr> <td>Content-Disposition</td> <td>This header is used to extract the file’s name. The value should be, for example: attachment; filename=“example.pdf”</td> </tr> <tr> <td>Link</td> <td>We use this header to specify the document that the file should be attached to. For example: https://api.mendeley.com/documents/cfb60e27-d3e4-397d-bb59-fc8388b98152</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A successful request will respond with a 201 Created code and a Location header where you can find the URL where you can download the file. <h2 id="deleting-a-file">Deleting a file</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/files/16bd4f6e-4578-3391-356d-66b374143457' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight python">file.delete() </code></pre> <pre><code class="highlight java">DeleteFileCallback deleteFileCallback = new DeleteFileCallback() { ... } asyncSdk.deleteFile("16bd4f6e-4578-3391-356d-66b374143457", deleteFileCallback); </code></pre> Deletes a file. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE /files/{id}</code> <h3 id="returns">Returns</h3> A successful request will respond with a 204 No Content code. Files are permanently deleted and cannot be recovered. <h1 id="file-content">File Content</h1> <h2 id="file-content-attributes">File Content attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>The unique identifier for the content.</td> </tr> <tr> <td>file_hash</td> <td>string</td> <td>sha-256 calculated from file to upload</td> </tr> <tr> <td>signature</td> <td>string</td> <td>sha-256 calculated from concatenated profile id (UUID) and file to upload</td> </tr> </tbody></table> <h2 id="uploading-file-content">Uploading file content</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/file_contents' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/pdf' \ -H 'Accept: application/vnd.mendeley-content-ticket.1+json' \ --data-binary @example.pdf { "id": "3f2f968f-553b-467d-8121-ba02cab937a0" } </code></pre> Uploads a file by sending its content as a payload. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/file_contents</code> <h3 id="headers">Headers</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>Content-Type</td> <td>string</td> <td>The mime type of the file. More info on mime types <a href="http://en.wikipedia.org/wiki/Internet_media_type">here</a>.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 201 OK response containing a JSON object with the id for the content. <h2 id="uploading-file-contents-via-file-hash-with-signature">Uploading file contents via file hash with signature</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/file_contents' \ -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-file-hash.1+json' \ -H 'Accept: application/vnd.mendeley-content-ticket.1+json' \ --data-binary '{"file_hash" : "4dab806d72af4224a5cfa168669dac17", "signature" : "7e280ae47152d6f39ddf7452fad300cf721c7b5c7487dfee434be0171e5031e1"}' { "id": "3f2f968f-553b-467d-8121-ba02cab937a0" } </code></pre> Uploads a file by sending a hash calculated from the file itself alongside a signature calculated from concatenated profile id (UUID) and the file itself. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/file_contents</code> <h3 id="returns">Returns</h3> A 201 OK response containing a JSON object with the id for the content. A 412 Precondition Failed response when fileHash or signature are invalid <h1 id="folders">Folders</h1> <h2 id="folder-attributes">Folder attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>id of the folder</td> </tr> <tr> <td>name</td> <td>string</td> <td>name of the folder</td> </tr> <tr> <td>parent_id</td> <td>string</td> <td>id of the parent folder</td> </tr> <tr> <td>group_id</td> <td>string</td> <td>id of the owning group</td> </tr> <tr> <td>created</td> <td>string</td> <td>date the folder was created. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>modified</td> <td>string</td> <td>date the folder was modified. This date is represented in ISO 8601 format.</td> </tr> </tbody></table> <h2 id="list-all-folders">List all folders</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders' \ -H 'Authorization: Bearer <ACCESS_TOKEN>'\ -H 'Accept: application/vnd.mendeley-folder.1+json' [ { "id": "68624820-2f4c-438d-ae54-ae2bc431cee3", "name": "API Related Papers", "created": "2014-04-08T10:11:40.000Z" }, { "id": "1cb47377-e3a1-40dd-bd82-11aff83a46eb", "name": "MapReduce", "created": "2014-07-02T13:19:36.000Z" } ] </code></pre> <pre><code class="highlight java">FolderList folderList = sdk.getFolders(); List<Folder> folders = folderList.folders; Page next = folderList.next; </code></pre> Retrieves a list of folders. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/folders</code> <h3 id="query-parameters">Query Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>group_id</td> <td>string</td> <td>returns all folders in a particular group.</td> </tr> <tr> <td>limit</td> <td>string</td> <td>maximum number of entries to be returned</td> </tr> <tr> <td>marker</td> <td>string</td> <td>a marker for the last key in the previous page (automatically generated, here for completeness)</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> Returns a paginated collection of all of the folders in the user’s library. <h2 id="creating-a-folder">Creating a folder</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-folder.1+json' \ -H 'Content-Type: application/vnd.mendeley-folder.1+json' \ --data-binary $'{"name": "My favourite publications"}' { "id": "a6433ad4-e694-498d-8134-b06d356e7f17", "name": "My favourite publications", "created": "2014-07-02T13:27:52.000Z" } </code></pre> <pre><code class="highlight java">Folder folder = new Folder.Builder().setName("My favourite publications").build(); sdk.postFolder(folder); </code></pre> Creates a folder. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/folders</code> <h3 id="returns">Returns</h3> A successful request will return a 201 and the newly created folder will be returned in the body. <h2 id="updating-a-folder">Updating a folder</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders/a6433ad4-e694-498d-8134-b06d356e7f17' \ -X PATCH -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-folder.1+json' \ --data-binary $'{"name": "My API Publications"}' </code></pre> <pre><code class="highlight java">Folder amendment = new Folder.Builder().setName("My API Publications").build(); sdk.patchFolder("a6433ad4-e694-498d-8134-b06d356e7f17", amendment); </code></pre> Update the <code class="prettyprint">name</code> and <code class="prettyprint">parent_id</code> of a folder. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/folders/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the folder</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response. <h2 id="deleting-a-folder">Deleting a folder</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders/a6433ad4-e694-498d-8134-b06d356e7f17' \ -X DELETE -H 'Authorization: Bearer <ACCESS_TOKEN>' \ </code></pre> <pre><code class="highlight java">sdk.deleteFolder("a6433ad4-e694-498d-8134-b06d356e7f17"); </code></pre> Deletes a folder. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE /folders/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the folder</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A successful request will return a 204 No Content. <h2 id="retrieving-documents-in-a-folder">Retrieving documents in a folder</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders/68624820-2f4c-438d-ae54-ae2bc431cee3/documents' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' [ { "id": "2bf33ebd-7cd1-3786-903d-d74d04958e40" }, { "id": "dc9c7b4d-4221-3872-8f78-817f6e125486" }, { "id": "9cd2fd1b-ec10-3bf8-a46f-d60e1b709075" }, { "id": "3078c081-717e-3525-81d7-c8e4b1cb9226" }, { "id": "f86a9bac-34ae-347f-860a-6687b38b18dc" }, { "id": "c395c80e-3112-3b1f-aebc-b3944cc2f8e9" } ] </code></pre> <pre><code class="highlight java">DocumentIdList docIdList = sdk.getFolderDocumentIds(null, "68624820-2f4c-438d-ae54-ae2bc431cee3"); List<DocumentId> docIds = docIdList.documentIds; Page next = docIdList.next; </code></pre> Retrive documents in a folder. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/folders/{id}/documents</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the folder</td> </tr> <tr> <td>limit</td> <td>string</td> <td>number of items to return</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A paginated collection of IDs of the documents in the folder. <h2 id="adding-a-document-to-a-folder">Adding a document to a folder</h2> Adds a document to a folder <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders/68624820-2f4c-438d-ae54-ae2bc431cee3/documents' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-document.1+json' \ --data-binary $'{"id": "cb58a7d9-8463-34e2-b1b8-457a3872ecdc"}' </code></pre> <pre><code class="highlight java">sdk.postDocumentToFolder("68624820-2f4c-438d-ae54-ae2bc431cee3", "cb58a7d9-8463-34e2-b1b8-457a3872ecdc"); </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/folders/{id}/documents</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the folder</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 201 Created response. <h2 id="deleting-a-document-from-a-folder">Deleting a document from a folder</h2> Deletes a document from a folder. This will remove the relationship between the folder and the document, but you can still access the document in your library or group. <pre><code class="highlight shell">curl 'https://api.mendeley.com/folders/68624820-2f4c-438d-ae54-ae2bc431cee3/documents/cb58a7d9-8463-34e2-b1b8-457a3872ecdc' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight java">sdk.DeleteDocumentFromFolder("68624820-2f4c-438d-ae54-ae2bc431cee3", "cb58a7d9-8463-34e2-b1b8-457a3872ecdc"); </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE https://api.mendeley.com/folders/{id}/documents/{document_id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the folder</td> </tr> <tr> <td>document_id</td> <td>string</td> <td>Identifier of the document to be deleted</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response. <h1 id="followers">Followers</h1> Follower resource represent a relationship follower/followee. <h2 id="followers-attributes">Followers attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>UUID of the relationship</td> </tr> <tr> <td>follower_id</td> <td>string</td> <td>UUID of the following profile</td> </tr> <tr> <td>followed_id</td> <td>string</td> <td>UUID of the followed profile</td> </tr> <tr> <td>status</td> <td>string</td> <td>Can be following or pending (for not yet accepted requests)</td> </tr> </tbody></table> <h2 id="retrieve-the-list-of-followers">Retrieve the list of followers</h2> Retrieve all the follow relationships for which the specified profile is the followee <pre><code class="highlight shell">curl 'https://api.mendeley.com/followers?followed=c0925ecf-4de0-3b61-ae9a-ebe5f7406327' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-follow.1+json' [ { "id": "15e75590-a1e8-31b5-b0ff-1777b27806a6", "follower_id": "b84e3c54-55ad-35b3-9102-1b8ae5c13714", "followed_id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "status": "following" }, { "id": "48cd5bcf-196c-3aac-a658-1d96bd77f2c9", "follower_id": "3c1c23ad-4dca-3065-86e4-5a168459a171", "followed_id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "status": "following" }, ... ] </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/followers?followed={followed_id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>followed_id</td> <td>string</td> <td>UUID of the profile for which the follower will be retrieved</td> </tr> <tr> <td>status</td> <td>string</td> <td>(optional) Limit the results of the query to following or pending relationships</td> </tr> <tr> <td>limit</td> <td>int</td> <td>The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 response containing a paginated list of follow relationships. <h2 id="retrieve-the-list-of-followees">Retrieve the list of followees</h2> Retrieve all the follow relationships for which the specified profile is the follower <pre><code class="highlight shell">curl 'https://api.mendeley.com/followers?follower=c0925ecf-4de0-3b61-ae9a-ebe5f7406327' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-follow.1+json' [ { "id": "0f68a3e7-2cfd-3ca7-beaf-969914c98b0b", "follower_id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "followed_id": "b84e3c54-55ad-35b3-9102-1b8ae5c13714", "status": "following" }, { "id": "275bc168-5fc9-3d42-a5d0-821244e866fe", "follower_id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "followed_id": "3c1c23ad-4dca-3065-86e4-5a168459a171", "status": "following" }, ... ] </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/followers?follower={follower_id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>follower_id</td> <td>string</td> <td>UUID of the profile for which the followees will be retrieved</td> </tr> <tr> <td>status</td> <td>string</td> <td>(optional) Limit the results of the query to following or pending relationships</td> </tr> <tr> <td>limit</td> <td>int</td> <td>The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 response containing a paginated list of follow relationships. <h2 id="follow-a-profile">Follow a profile</h2> Create a follow relationship with the logged profile as followers and the followed profile specified in the body. <pre><code class="highlight shell">curl -X POST 'https://api.mendeley.com/followers' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-follow-request.1+json' \ --data-binary '{"followed" : "c0925ecf-4de0-3b61-ae9a-ebe5f7406327"}' { "id": "ba7073da-ec89-347a-9651-6f46235f93a3", "follower_id": "618fbf26-cd24-39d4-a49f-ceddccccfeb0", "followed_id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "status": "following" } </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST https://api.mendeley.com/followers</code> <h3 id="returns">Returns</h3> A 201 Created response containing the follow object. <h2 id="accept-a-follow-request">Accept a follow request</h2> Change the status of a relationship from pending to following. <pre><code class="highlight shell">curl -X PATCH 'https://api.mendeley.com/followers/135e5b6e-ba36-3321-a33e-986ae35779bb' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-follow-acceptance.1+json' \ --data-binary '{"status" : "following"}' { "id": "135e5b6e-ba36-3321-a33e-986ae35779bb", "follower_id": "105da48f-4201-37cf-9e2f-67c49c0707b0", "followed_id": "618fbf26-cd24-39d4-a49f-ceddccccfeb0", "status": "following" } </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/followers/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>UUID of the relationship</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing the updated follow object. <h2 id="cancel-follow-request">Cancel follow request</h2> Same procedure as <a href="#unfollow-a-profile">Unfollow a profile</a> <h2 id="reject-follow-request">Reject follow request</h2> Same procedure as <a href="#unfollow-a-profile">Unfollow a profile</a> <h2 id="unfollow-a-profile">Unfollow a profile</h2> Delete the follow relationship. <pre><code class="highlight shell">curl -X DELETE 'https://api.mendeley.com/followers/87fee9d4-3ea1-36fd-a2c4-ba2796564cb0' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE https://api.mendeley.com/followers/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>UUID of the relationship</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response in case of success. <h1 id="groups">Groups</h1> <h2 id="group-attributes">Group attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the group. This identifier is set by the server on create and cannot be modified.</td> </tr> <tr> <td>link</td> <td>string</td> <td>URL of the group page in Mendeley.</td> </tr> <tr> <td>owning_profile_id</td> <td>string</td> <td>Profile identifier of the owner of the group.</td> </tr> <tr> <td>access_level</td> <td>string</td> <td>Whether the group is public, private or invite_only. More on access levels below.</td> </tr> <tr> <td>created</td> <td>string</td> <td>Date the group was created. This date is set by the server after a successful create reques and is represented in ISO 8601 format.</td> </tr> <tr> <td>name</td> <td>string</td> <td>The name of the group.</td> </tr> <tr> <td>description</td> <td>string</td> <td>Small description of what the group is about.</td> </tr> <tr> <td>photo</td> <td>object</td> <td>The photo object contains the URL to the photo/logo of the group. There are three sizes available: original, standard and square.</td> </tr> <tr> <td>webpage</td> <td>string</td> <td>Website of the group outside Mendeley.</td> </tr> <tr> <td>disciplines</td> <td>array</td> <td>List of disciplines the group is part of.</td> </tr> <tr> <td>tags</td> <td>array</td> <td>List of tags assigned to the group.</td> </tr> <tr> <td>role</td> <td>string</td> <td>Role of the authenticated user in the group. More on group roles below.</td> </tr> </tbody></table> <h3 id="group-roles">Group roles</h3> <ul> <li>owner: the creator of the group.</li> <li>admin: administrator of the group. Only owners and admins can make other members administrators.</li> <li>normal: normal member of the group. Users can add new references, add files and start discussions in the newsfeed of the group.</li> <li>follower: followers of the group. Only public groups can have followers. Followers cannot interact with other members, i.e. post in newsfeed and participate in discussions, nor add references to the group. This is a read-only access membership.</li> <li>invited: person who has been invited to the group, but not accepted the invitation. This is a read-only access membership.</li> </ul> <h2 id="retrieving-groups">Retrieving groups</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/groups' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-group.1+json' [ { "name": "Mendeley Advisor Group", "description": "This is an invite-only communication channel for Mendeley Advisors. Meet your fellow advisors from around the world, share papers, presentations, tips, and let us know how we're doing. Also feel free to post your upcoming presentation to the \"Events Page\" by adding it here: www.mendeley.com/events. Add tips, tricks, and any relevant updates to the Mendeley Resource Center: http://resources.mendeley.com/", "disciplines": [ "Computer and Information Science", "Social Sciences", "Design" ], "tags": [], "photo": { "original": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876.png", "standard": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876-standard.jpg", "square": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876-square.jpg" }, "webpage": "http://resources.mendeley.com/", "id": "3463d2a0-f87e-3fea-a446-6c8287ce5a2f", "created": "2010-11-15T20:03:35.000Z", "owning_profile_id": "81727124-ca03-3684-ad66-90a4603bde26", "link": "http://www.mendeley.com/groups/665771/mendeley-advisor-group/", "role": "user", "access_level": "private" }, { "name": "Mendeley API", "description": "A group for people interested in the Mendeley API.", "disciplines": [ "Social Sciences" ], "tags": [], "photo": { "original": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876.png", "standard": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876-standard.jpg", "square": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876-square.jpg" }, "webpage": "http://dev.mendeley.com/", "id": "9da69ed0-9d44-3d5f-b999-970f41c94c35", "created": "2014-06-19T14:34:19.000Z", "owning_profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "link": "http://www.mendeley.com/groups/4599001/mendeley-api/", "role": "owner", "access_level": "public" } ] </code></pre> <pre><code class="highlight python">for group in mendeley.groups.iter(): print group.name </code></pre> <pre><code class="highlight java">GroupList groupList = sdk.getGroups(null); List<Group> groups = groupList.groups; Page next = groupList.next; </code></pre> Retrieve all groups a user belongs to. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/groups</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A paginated collection of groups. <h2 id="retrieving-a-group">Retrieving a group</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/groups/9da69ed0-9d44-3d5f-b999-970f41c94c35' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-group.1+json' [ { "name": "Mendeley API", "description": "A group for people interested in the Mendeley API.", "disciplines": [ "Social Sciences" ], "tags": [], "photo": { "original": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876.png", "standard": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876-standard.jpg", "square": "http://s3.amazonaws.com/mendeley-photos/bc/e8/bce8c532283273fb0f511321adcc2cafd07f5876-square.jpg" }, "webpage": "http://dev.mendeley.com/", "id": "9da69ed0-9d44-3d5f-b999-970f41c94c35", "created": "2014-06-19T14:34:19.000Z", "owning_profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "link": "http://www.mendeley.com/groups/4599001/mendeley-api/", "role": "owner", "access_level": "public" } ] </code></pre> <pre><code class="highlight python">group = mendeley.groups.get('9da69ed0-9d44-3d5f-b999-970f41c94c35') print group.name </code></pre> <pre><code class="highlight java">Group group = sdk.getGroup("9da69ed0-9d44-3d5f-b999-970f41c94c35"); </code></pre> Retrieve a single group a user belongs to. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/groups/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>unique id of the group</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response with the group information. <h2 id="retrieving-members-from-groups">Retrieving members from groups</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/groups/9da69ed0-9d44-3d5f-b999-970f41c94c35/members' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-membership.1+json' [ { "profile_id": "8349a3f4-8894-3910-81da-4f5d7a396e2a", "role": "user", "joined": "2014-07-02T00:13:10.000Z" }, { "profile_id": "d9ef2853-d330-3427-b90f-eff3f3fc14a3", "role": "user", "joined": "2014-06-30T17:34:32.000Z" }, { "profile_id": "caddcde9-bce7-3bd0-8762-c5058f92d910", "role": "user", "joined": "2014-07-01T08:32:29.000Z" }, { "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "role": "owner", "joined": "2014-06-19T14:37:14.000Z" }, { "profile_id": "27dcaab3-d366-3c39-83c9-a53e4961ac98", "role": "admin", "joined": "2014-06-19T14:34:19.000Z" } ] </code></pre> <pre><code class="highlight python">for member in group.members.iter(): print member.display_name </code></pre> <pre><code class="highlight java">GroupMembersList groupMembersList = sdk.getGroupMembers(null, "9da69ed0-9d44-3d5f-b999-970f41c94c35"); List<UserRole> roles = groupMembersList.userRoles; List<String> memberProfileIds = new ArrayList<String>(); for (UserRole role : roles) { memberProfileIds.add(role.profileId); } Page next = groupMembersList.next; </code></pre> Returns information about the members in a group <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/groups/{id}/members</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A paginated collection of user roles. <h1 id="groups-v2">Groups-V2</h1> <h2 id="group-attributes">Group attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the group. This identifier is set by the server on create and cannot be modified.</td> </tr> <tr> <td>link</td> <td>string</td> <td>URL of the group.</td> </tr> <tr> <td>owning_profile_id</td> <td>string</td> <td>Profile identifier of the owner of the group.</td> </tr> <tr> <td>access_level</td> <td>string</td> <td>Whether the group is public, private or invite_only. More on access levels below.</td> </tr> <tr> <td>created</td> <td>string</td> <td>Date the group was created. This date is set by the server after a successful create request and is represented in ISO 8601 format.</td> </tr> <tr> <td>name</td> <td>string</td> <td>The name of the group.</td> </tr> <tr> <td>description</td> <td>string</td> <td>Small description of what the group is about.</td> </tr> <tr> <td>photo</td> <td>object</td> <td>The photo object contains the URL to the photo/logo of the group. There are three sizes available: original, standard and square.</td> </tr> <tr> <td>webpage</td> <td>string</td> <td>Website of the group outside Mendeley.</td> </tr> <tr> <td>disciplines</td> <td>array</td> <td>List of disciplines the group is part of.</td> </tr> <tr> <td>tags</td> <td>array</td> <td>List of tags assigned to the group.</td> </tr> <tr> <td>role</td> <td>string</td> <td>Role of the authenticated user in the group. More on group roles below.</td> </tr> </tbody></table> <h3 id="group-roles">Group roles</h3> <ul> <li>owner: owner of the group.</li> <li>admin: administrator of the group. Only owners and admins can make other members administrators.</li> <li>normal: normal member of the group. Users can add new references, add files and start discussions in the newsfeed of the group.</li> <li>follower: followers of the group. Only public and invite-only groups can have followers. Followers cannot interact with other members, i.e. post in newsfeed and participate in discussions, nor add references to the group. This is a read-only access membership.</li> </ul> <h3 id="group-types">Group types</h3> <ul> <li>private: publically not visible, users can’t join nor follow, they have to be invited.</li> <li>invite_only: publically visible, users can’t join, can follow, can ask to join.</li> <li>public: publically visible, user can join or follow.</li> </ul> <h2 id="creating-group">Creating group</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-Type: application/vnd.mendeley-group+json" \ -H "Accept: application/vnd.mendeley-group+json" \ --data-binary @new-group.json new-group.json: { "name": "New group", "description": "New group description", "access_level": "public", "disciplines": ["Veterinary Science and Veterinary Medicine"], "tags": ["tag01", "tag02"] } Response: { "name": "New group", "description": "New group description", "disciplines": [ "Veterinary Science and Veterinary Medicine" ], "tags": [ "tag01", "tag02" ], "photo": { "standard": "http://s3.amazonaws.com/mendeley-photos/awaiting.png", "square": "http://s3.amazonaws.com/mendeley-photos/disciplines/small/veterinary-science-and-veterinary-medicine.png" }, "id": "efe1b21a-7d57-38bd-1d1e-314db97dc11a", "created": "2016-07-01T13:48:03.000Z", "owning_profile_id": "61eef301-26ac-2841-a143-c4c7ec1826af", "link": "http://api.mendeley.com/groups/v2/efe8b71a-7d57-38bd-9d1e-314db97dc21a", "invite_only": false, "public": true, "role": "owner", "access_level": "public" } </code></pre> <h2 id="retrieving-groups">Retrieving groups</h2> <pre><code class="highlight shell">curl -X GET "https://api.mendeley.com/groups/v2" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.mendeley-group-list+json" [ { "name": "Some group", "id": "efe1b21a-7d57-38bd-1d1e-314db97dc11a", ... }, { "name": "Another group", "id": "dee1b21a-7d57-38bd-1d1e-314db97dc11b", ... } ] </code></pre> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h2 id="updating-group">Updating group</h2> <pre><code class="highlight shell">curl -X PATCH "https://api.mendeley.com/groups/v2/05bedb28-71ad-328b-82cb-9d6fb2e4ddf7" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-type: application/vnd.mendeley-group+json" \ -H "Accept: application/vnd.mendeley-group+json" \ --data-binary @patch_group.json patch_group.json: { "name" : "New name", "description" : "New description", "disciplines": [ "Veterinary Science and Veterinary Medicine" ] } Response: { "name": "New name", "id": "05bedb28-71ad-328b-82cb-9d6fb2e4ddf7" "description": "New description", "disciplines": [ "Veterinary Science and Veterinary Medicine" ], ... } </code></pre> <h2 id="deleting-group">Deleting group</h2> <pre><code class="highlight shell">curl -X DELETE "https://api.mendeley.com/groups/v2/05bedb28-71ad-328b-82cb-9d6fb2e4ddf7" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="retrieving-group">Retrieving group</h2> <pre><code class="highlight shell">curl -X GET "https://api.mendeley.com/groups/v2/05bedb28-71ad-328b-82cb-9d6fb2e4ddf7" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.mendeley-group+json" { "name": "New name", "id": "05bedb28-71ad-328b-82cb-9d6fb2e4ddf7" "description": "New description", "disciplines": [ "Veterinary Science and Veterinary Medicine" ], ... } </code></pre> <h2 id="retrieving-popular-groups">Retrieving popular groups</h2> <pre><code class="highlight shell">curl -X GET "https://api.mendeley.com/groups/v2/popular" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.mendeley-group-list+json" [ { "name": "New name", "id": "05bedb28-71ad-328b-82cb-9d6fb2e4ddf7" "description": "New description", "disciplines": [ "Veterinary Science and Veterinary Medicine" ], ... }, { "name": "Another group", "id": "6529abcd-71ad-328b-82cb-9d6fb2e4ddf7" "description": "Another description", "disciplines": [ "Veterinary Science and Veterinary Medicine" ], ... } ] </code></pre> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>limit</td> <td>int</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h2 id="retrieving-group-members">Retrieving group members</h2> <pre><code class="highlight shell">curl -X GET "https://api.mendeley.com/groups/v2/05bedb28-71ad-328b-82cb-9d6fb2e4ddf7/members" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.mendeley-group-member-list+json" [ { "profile_id": "17eef301-26fd-7641-a143-c4c7ec1822af", "joined": "2016-07-01T13:50:30.000Z", "role": "owner" }, { "profile_id": "17eef301-26fd-2269-a143-c4c7ec1822af", "joined": "2016-07-01T13:50:30.000Z", "role": "admin" } ] </code></pre> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>query</td> <td>string</td> <td>search query which is matched against members first or last name.</td> </tr> <tr> <td>limit</td> <td>int</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h2 id="joining-public-group">Joining public group</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/members" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="leaving-public-group">Leaving public group</h2> <pre><code class="highlight shell">curl -X DELETE "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/members" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="following-group">Following group</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/followers" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="unfollowing-group">Unfollowing group</h2> <pre><code class="highlight shell">curl -X DELETE "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/followers" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="removing-member-from-group">Removing member from group</h2> <pre><code class="highlight shell">curl -X DELETE "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/members/e9e11302-4887-30c8-88ec-fbded0cc22a3" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="updates-member's-role">Updates member’s role</h2> <pre><code class="highlight shell">curl -X PATCH "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/members/e9e11302-4887-30c8-88ec-fbded0cc22a3" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-type: application/vnd.mendeley-group-membership+json" \ -H "Accept: application/vnd.mendeley-group-membership+json" \ --data-binary @new_membership.json new_membership.json: { "membership" : "admin" } Response: { "profile_id": "e9e11302-4887-30a1-88ec-fbded0cc22a3", "joined": "2016-07-01T14:03:26.000Z", "role": "admin" } </code></pre> <h2 id="inviting-users">Inviting users</h2> Note: Sending email is currently disabled <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/invitations" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-type: application/vnd.mendeley-group-invitation+json" \ -H "Accept: application/vnd.mendeley-group-invitation-response-list+json" \ --data-binary @invitations.json invitations.json: { "recipients" : [ { "email" : "email1@abc.com" }, { "email" : "email2@abc.com"}, { "email" : "email3@abc.com"} ], "message" : "Custom invitation message which should be included in the mail" } Response: [ { "email": "email1@abc.com", "invitation_uuid": "4ea48e40-20c5-4ff9-8153-4ab0487bf1da" }, { "email": "email2@abc.com", "error_message": "Use already in a group" }, { "email": "email3@abc.com", "invitation_uuid": "153e8734-f879-4838-93f1-b0e69bc49041", "warning_message": "Email sending failure" } ] </code></pre> <h2 id="retrieving-group-invitations">Retrieving group invitations</h2> <pre><code class="highlight shell">curl -X GET "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/invitations" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.mendeley-group-invitation-list+json" [ { "invitation_uuid": "8aa48e40-20c5-4ff9-8111-12b0487bf1da", "group_uuid": "f8c54bf7-82ba-374a-8877-3cac3fc15c5f", "invitee_email": "email1@abc.com", "status": "SENT", "sent": "2016-07-04T14:54:03.000Z", "message": "Custom invitation message which should be included in the mail" }, { "invitation_uuid": "a4a529b9-6b83-40f9-9191-6fb55699042f", "invitee_profile_uuid": "55686f2d-b821-3997-a968-2430d6e1eb1e", "group_uuid": "f8c54bf7-a5d5-374a-9283-3cac3fc15c5f", "invitee_name": "John Smith", "invitee_email": "email3@abc.com", "status": "CREATED", "sent": "2016-07-04T14:54:03.000Z", "message": "Custom invitation message which should be included in the mail" } ] </code></pre> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>invitation_code</td> <td>string</td> <td>invitation code of a single invitation to retrieve. It’s a mean to distinguish a non-Mendeley user who was invited to the group from other non-Mendeley users.</td> </tr> <tr> <td>limit</td> <td>int</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h2 id="retrieving-user-invitations">Retrieving user invitations</h2> <pre><code class="highlight shell">curl -X GET "https://api.mendeley.com/groups/v2/invitations" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.mendeley-group-invitation-list+json" [ { "invitation_uuid": "d5a85daa-8eb3-4857-a6b2-28e11a97ca96", "invitee_profile_uuid": "abc23f13-134a-3f51-906e-d81643ef7dc4", "group_uuid": "f8c54bf7-a5d5-374a-2177-3cac3fc15c5f", "invitee_name": "John Smith", "invitee_email": "email3@abc.com", "status": "SENT", "sent": "2016-07-04T15:08:45.000Z", "message": "Custom invitation message which should be included in the mail" } ] </code></pre> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>limit</td> <td>int</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500.</td> </tr> </tbody></table> <h2 id="accepting-invitation">Accepting invitation</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/invitations/d5a85daa-8eb3-4857-a6b2-28e11a97ca96/actions/accept" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="declining-invitation">Declining invitation</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/invitations/d5a85daa-8eb3-4857-a6b2-28e11a97ca96/actions/decline" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="revoking-invitation">Revoking invitation</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/invitations/d5a85daa-8eb3-4857-a6b2-28e11a97ca96/actions/revoke" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="resending-invitation">Resending invitation</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/invitations/d5a85daa-8eb3-4857-a6b2-28e11a97ca96/actions/resend" \ -H "Authorization: Bearer <ACCESS_TOKEN>" </code></pre> <h2 id="asking-to-join-a-group">Asking to join a group</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/actions/join_request" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-type: application/vnd.mendeley-group-message+json" \ --data-binary @message.json message.json: { "message": "I would like to join your group" } </code></pre> <h2 id="accepting-join-request">Accepting join request</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/members/abc23f13-134a-3f51-906e-d81643ef7dc4/actions/accept" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-type: application/vnd.mendeley-group-message+json" \ --data-binary @message.json message.json: { "message": "I accept your request!" } </code></pre> <h2 id="declining-join-request">Declining join request</h2> <pre><code class="highlight shell">curl -X POST "https://api.mendeley.com/groups/v2/c0bdadf0-1592-38b3-a1e3-a8be3b1b8d6c/members/abc23f13-134a-3f51-906e-d81643ef7dc4/actions/decline" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Content-type: application/vnd.mendeley-group-message+json" \ --data-binary @message.json message.json: { "message": "I decline your request!" } </code></pre> <h1 id="identifier-types">Identifier Types</h1> <h2 id="retrieve-all-identifier-types">Retrieve all identifier types</h2> Retrieves all identifier types used. <pre><code class="highlight shell">curl 'https://api.mendeley.com/identifier_types' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document-identifier.1+json' [ { "name": "arxiv", "description": "arXiv ID" }, { "name": "doi", "description": "DOI" }, { "name": "isbn", "description": "ISBN" }, { "name": "issn", "description": "ISSN" }, { "name": "pmid", "description": "PubMed Unique Identifier (PMID)" }, { "name": "scopus", "description": "Scopus identifier (EID)" } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/identifier_types</code> <h3 id="returns">Returns</h3> A 200 OK response containing a all identifier types. <h1 id="institution-trees">Institution Trees</h1> An institution tree is a set of institutions that form a hierarchy, connected by the parent_id attribute, eg. Cambridge University -> University of Cambridge Pembroke College etc. The id field within the response indicates the root institution. An institution tree may be either partial or complete. Partial infers that the root institution may have a parent, whereas complete is where the root institution has no parent. <h2 id="institution-tree-attributes">Institution tree attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the root institution. This should be used by tree walking algorithms, eg. to build the tree.</td> </tr> <tr> <td>institution_nodes</td> <td>array</td> <td>List of institutions as <a href="#institutions">institution</a> objects.</td> </tr> </tbody></table> <h2 id="retrieving-complete-institution_trees">Retrieving complete institution_trees</h2> This institution_id parameter may be any institution within the returned tree, eg. it could be a leaf node. <pre><code class="highlight shell">curl 'https://api.mendeley.com/institution_trees?institution_id=7f821859-e00b-5e3c-ad18-a03ad306f343' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-institution.1+json' [ { "id": "7f821859-e00b-5e3c-ad18-a03ad306f343", "institution_nodes": [ { "id": "7f821859-e00b-5e3c-ad18-a03ad306f343", "name": "Christchurch Polytechnic Institute of Technology", "city": "Christchurch", "state": "", "country": "NZ", "urls": [ "www.cpit.ac.nz" ], "alt_names": [ { "name": "Library Learning and Information Services - Te Ara Awhina i te Matauranga" }, { "name": "CPIT" } ] }, { "id": "575055ff-a851-577b-8ad4-9b8f938382e6", "name": "Christchurch Polytechnic Institute of Technology School of Nursing and Human Services", "city": "Christchurch", "state": "", "country": "NZ", "parent_id": "7f821859-e00b-5e3c-ad18-a03ad306f343", "urls": [ "www.cpit.ac.nz/schools/school_of_nursing" ] } ] } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/institution_trees</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>institution_id</td> <td>string</td> <td>Contained institution node</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response. A 403 Forbidden, tree to large. <h2 id="retrieving-partial-institution_trees">Retrieving partial institution_trees</h2> The id passed in the URL will always be the root id of the resulting tree. nb. A parent_id exists for this example, which differs from the root id, hence it is a partial tree. <pre><code class="highlight shell">curl 'https://api.mendeley.com/institution_trees/575055ff-a851-577b-8ad4-9b8f938382e6' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-institution.1+json' { "id": "575055ff-a851-577b-8ad4-9b8f938382e6", "institution_nodes": [ { "id": "575055ff-a851-577b-8ad4-9b8f938382e6", "name": "Christchurch Polytechnic Institute of Technology School of Nursing and Human Services", "city": "Christchurch", "state": "", "country": "NZ", "parent_id": "7f821859-e00b-5e3c-ad18-a03ad306f343", "urls": [ "www.cpit.ac.nz/schools/school_of_nursing" ] } ] } </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/institution_trees/{id}</code> <h3 id="returns">Returns</h3> A 200 OK response. A 403 Forbidden, tree to large. <h1 id="institutions">Institutions</h1> <h2 id="institution-attributes">Institution attributes</h2> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the institution.</td> </tr> <tr> <td>name</td> <td>string</td> <td>English name of the institution.</td> </tr> <tr> <td>city</td> <td>string</td> <td>City.</td> </tr> <tr> <td>state</td> <td>string</td> <td>State.</td> </tr> <tr> <td>country</td> <td>string</td> <td>Country.</td> </tr> <tr> <td>parent_id</td> <td>string</td> <td>Identifier (UUID) of the parent institution, where one exists.</td> </tr> <tr> <td>urls</td> <td>array</td> <td>URLs associated with the institution.</td> </tr> <tr> <td>alt_names</td> <td>array</td> <td>List of alternative names for the institution, as <a href="#alt_names">alt_name</a> objects.</td> </tr> </tbody></table> <h4 id="alt_names">alt_names</h4> An alternative name is represented as an object with the following attribute: <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>string</td> <td>Alternative name</td> </tr> </tbody></table> <h2 id="retrieving-institutions-by-hint">Retrieving institutions by hint</h2> <ul> <li>Hint must be at least three characters in length.</li> <li>Limited to 100 results. If no limit is provided then up to 100 results will be returned.</li> <li>Ordering of results is primarily based upon size of institution in terms of person count.</li> <li>Name and alternative names are searched when retrieving by hint.</li> <li>Hint is case insensitive.</li> </ul> <pre><code class="highlight shell">curl 'https://api.mendeley.com/institutions?hint=mendel&limit=3' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-institution.1+json' [ { "id": "914b908c-e917-58fe-8a66-4361f1abf95f", "name": "Mendel University Brno", "city": "Brno", "state": "", "country": "CZ", "urls": [ "www.mendelu.cz" ], "alt_names": [ { "name": "Mendel University of Agriculture and Forestry" }, { "name": "Mendelova Univerzita v Brn?" }, { "name": "Mendelova Zemedelska a Lesnicka Univerzita v Brne" }, { "name": "Mendelova univerzita v Brne" }, { "name": "Mendel University in Brno" } ] }, { "id": "af7cf891-ad7b-5ce9-8913-0515da40b8a7", "name": "Rossiiskii khimiko-tekhnologicheskii universitet imeni DI Mendeleeva", "city": "Moscow", "state": "", "country": "RU", "urls": [ "www.muctr.ru" ], "alt_names": [ { "name": "MUCTR" }, { "name": "Mendeleev University of Chemical Technology of Russia" } ] }, { "id": "38fbed71-139f-5dbc-95f6-b41714220efd", "name": "Yeshiva University", "city": "New York", "state": "NY", "country": "US", "urls": [ "www.yu.edu" ], "alt_names": [ { "name": "Pollack Library" }, { "name": "Mendel Gottesman Library" } ] } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h2 id="retrieving-institutions-by-email-address">Retrieving institutions by email address</h2> <ul> <li>The email domain (everything to the right of the @ symbol) will be matched against the URLs (stripped of www prefix) of the institutions. </li> <li>Exact matches, if any, will be returned above partial matches.</li> <li>Ordering of results is primarily based upon size of institution in terms of person count.</li> <li>Limited to 100 results. If no limit is provided then up to 100 results will be returned.</li> </ul> <pre><code class="highlight shell">curl 'https://api.mendeley.com/institutions?email=joe%40cam.ac.uk&limit=3' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-institution.1+json' [ { "id": "9bb25e66-bd83-544e-b1b5-d0df25a29993", "name": "University of Cambridge", "city": "Cambridge", "state": "Cambridgeshire", "country": "GB", "urls": [ "www.cam.ac.uk" ], "alt_names": [ { "name": "Cambridge University" }, { "name": "University of Cambridge Betty and Gordon Moore Library" }, { "name": "University of Cambridge Central Science Library" } ] }, { "id": "162d9c14-ff65-5d59-89ab-77dffb2d0e04", "name": "University of Cambridge Department of Land Economy", "city": "Cambridge", "state": "Cambridgeshire", "country": "GB", "parent_id": "afd94196-b4a8-5453-a28f-79525ed43efc", "urls": [ "www.landecon.cam.ac.uk" ], "alt_names": [ { "name": "Mill Lane Library" } ] }, { "id": "dae880dd-777a-5746-a9ea-7ad1eeefa48d", "name": "University of Cambridge Institute of Manufacturing", "city": "Cambridge", "state": "Cambridgeshire", "country": "GB", "parent_id": "9dcf803c-32b9-501f-844c-ccfbcf36bad8", "urls": [ "www.ifm.eng.cam.ac.uk" ] } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h2 id="retrieving-institutions-by-name">Retrieving institutions by name</h2> <ul> <li>This search matches the exact (case insensitive) name provided against the institution name field. </li> <li>City, state and country (or any combination) may also be given to limit the results where name has multiple matches.</li> <li>Ordering of results is primarily based upon size of institution in terms of person count.</li> <li>Limited to 100 results. If no limit is provided then up to 100 results will be returned.</li> </ul> <pre><code class="highlight shell">curl 'https://api.mendeley.com/institutions?limit=10&name=City%20University' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-institution.1+json' [ { "id": "0e091aba-868f-5c72-8b0b-6e2ec9e289f5", "name": "City University", "city": "London", "state": "London", "country": "GB", "urls": [ "www.city.ac.uk" ], "alt_names": [ { "name": "City University Centre for Investigative Security and Police Sciences" }, { "name": "City University Library" } ] }, { "id": "354eff87-07e7-5c9f-881b-a1fa3f5f4fa4", "name": "City University", "city": "Dhaka", "state": "Dhaka District", "country": "BD", "urls": [ "cityuniversity.edu.bd" ], "alt_names": [ { "name": "CU" } ] } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/institutions</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>hint</td> <td>string</td> <td>Part of institution name</td> </tr> <tr> <td>email</td> <td>string</td> <td>Email address</td> </tr> <tr> <td>name</td> <td>string</td> <td>Full institution name</td> </tr> <tr> <td>city</td> <td>string</td> <td>City of institution</td> </tr> <tr> <td>state</td> <td>string</td> <td>State of institution</td> </tr> <tr> <td>country</td> <td>string</td> <td>Country of institution</td> </tr> <tr> <td>limit</td> <td>integer</td> <td>Max number of results, defaults and limited to 100</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response <h2 id="retrieve-institution-by-id">Retrieve institution by id</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/institutions/354eff87-07e7-5c9f-881b-a1fa3f5f4fa4' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-institution.1+json' { "id": "354eff87-07e7-5c9f-881b-a1fa3f5f4fa4", "name": "City University", "city": "Dhaka", "state": "Dhaka District", "country": "BD", "urls": [ "cityuniversity.edu.bd" ], "alt_names": [ { "name": "CU" } ] } </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/institutions/{id}</code> <h3 id="returns">Returns</h3> A 200 OK response <h1 id="locations">Locations</h1> <h2 id="suggest-locations">Suggest locations</h2> Suggests possible locations for a given prefix. Suggestions will be provided in cases where: <ul> <li> an unaccented search term will return an accented suggestion e.g. Evreux will return Évreux</li> <li> an accented search term will return an accented suggestion e.g. Évreux will return Évreux</li> <li> an accented search term will return an unaccented suggestion e.g. ádḍîś äḅâbà will return Addis Ababa</li> </ul> <pre><code class="highlight shell">curl 'https://api.mendeley.com/locations?prefix=LON&limit=3' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H "Accept: application/vnd.mendeley-location.1+json" [ { "id": "cc185ce9-a459-43c5-849d-35ee6b8bfd05", "latitude": -13.92, "longitude": -171.47, "name": "Lona, Samoa", "city": "Lona", "state": "Rest of Upolu", "country": "Samoa" }, { "id": "c8c1a5e9-841d-4e46-8796-35ee6b8b3839", "latitude": 39.6002, "longitude": -79.0112, "name": "Lonaconing, Maryland, United States", "city": "Lonaconing", "state": "Maryland", "country": "United States" }, { "id": "d369b444-6741-4510-a9e1-35ee6b8b9a6a", "latitude": 19.98, "longitude": 76.53, "name": "Lonār, India", "city": "Lonār", "state": "Maharashtra", "country": "India" } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/locations?prefix={prefix}&limit={limit}</code> <h3 id="query-parameters">Query Parameters</h3> These are required query parameters. <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>prefix</td> <td>string</td> <td>first few characters of a city</td> </tr> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 100</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a all locations <h2 id="retrieve-a-location">Retrieve a location</h2> Retrieves a location by a ID <pre><code class="highlight shell">curl 'https://api.mendeley.com/locations/c8c1a5e9-841d-4e46-8796-35ee6b8b3839' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H "Accept: application/vnd.mendeley-location.1+json" { "id": "c8c1a5e9-841d-4e46-8796-35ee6b8b3839", "latitude": 39.6002, "longitude": -79.0112, "name": "Lonaconing, Maryland, United States", "city": "Lonaconing", "state": "Maryland", "country": "United States" } </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/locations/{id}</code> <h3 id="query-parameters">Query Parameters</h3> These are required query parameters. <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document. This identifier is set by the server on create and it cannot be modified.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a single location <h1 id="profiles">Profiles</h1> <h2 id="profile-attributes">Profile attributes</h2> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the profile.</td> </tr> <tr> <td>first_name</td> <td>string</td> <td>First name of the user. This is a required field.</td> </tr> <tr> <td>last_name</td> <td>string</td> <td>Last name of the user. This is a required field.</td> </tr> <tr> <td>location</td> <td>object</td> <td>Current location of the user. The location object has the following information: name, latitude, longitude.</td> </tr> <tr> <td>display_name</td> <td>string</td> <td>Name of the user including their title.</td> </tr> <tr> <td>email</td> <td>string</td> <td>Primary email of the user. This is used as username for login into Mendeley services. The email will only be exposed through the GET /profiles/me request, but it will never be exposed to other users.</td> </tr> <tr> <td>research_interests</td> <td>string</td> <td>Comma separated list of research topics the user is interested in.</td> </tr> <tr> <td>education</td> <td>array[Education]</td> <td>Collection of education objects. See below for documentation.</td> </tr> <tr> <td>employment</td> <td>array[Employment]</td> <td>Collection of employment objects.See below for documentation.</td> </tr> <tr> <td>academic_status</td> <td>string</td> <td>Current academic status of the profile. Possible values can be found by doing GET /academic_statuses.</td> </tr> <tr> <td>link</td> <td>string</td> <td>URL to the Mendeley public profile page.</td> </tr> <tr> <td>discipline</td> <td>Discipline</td> <td>Current research discipline. Possible values can be found by doing GET /disciplines.</td> </tr> <tr> <td>disciplines</td> <td>array[Discipline]</td> <td>Additional research . Possible values can be found by doing GET /disciplines.</td> </tr> <tr> <td>photo</td> <td>object</td> <td>(TO BE DEPRECATED - Please use Photos) The photo object contains the URL to the profile’s picture. There are three sizes available: original, standard and square.</td> </tr> <tr> <td>photos</td> <td>array[Image]</td> <td>Collection of Image objects for the profile’s picture. Each Image contains width, height, URL and original where original is the initially uploaded photo</td> </tr> <tr> <td>verified</td> <td>boolean</td> <td>Whether the profile has verified their email address or not.</td> </tr> <tr> <td>created</td> <td>string</td> <td>Date when the profile was created. This date is set by the server on creation and is represented in ISO 8601 format.</td> </tr> <tr> <td>biography</td> <td>string</td> <td>Biographical information</td> </tr> <tr> <td>marketing</td> <td>boolean</td> <td>Opt in or out of marketing material</td> </tr> <tr> <td>user_type</td> <td>UserType</td> <td>Possible types are ‘normal’ or 'devpartner’ or 'advisor’ or 'lead’ or 'staff’ or 'admin’</td> </tr> </tbody></table> <h3 id="education">Education</h3> Education is represented as an object with the following attributes: <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>institution</td> <td>string</td> <td>255</td> <td>Name of the institution.</td> </tr> <tr> <td>degree</td> <td>string</td> <td>100</td> <td>Degree</td> </tr> <tr> <td>start_date</td> <td>string</td> <td>-</td> <td>Start date at institution. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>end_date</td> <td>string</td> <td>-</td> <td>End date at institution. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>website</td> <td>string</td> <td>255</td> <td>Website of the institution.</td> </tr> </tbody></table> <h3 id="employment">Employment</h3> Employment is representated as a on object with the following attributes: <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>institution</td> <td>string</td> <td>255</td> <td>Name of the institution.</td> </tr> <tr> <td>position</td> <td>string</td> <td>100</td> <td>Position held at instituion.</td> </tr> <tr> <td>degree</td> <td>string</td> <td>100</td> <td>Degree</td> </tr> <tr> <td>start_date</td> <td>string</td> <td>-</td> <td>Start date at institution. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>end_date</td> <td>string</td> <td>-</td> <td>End date at institution. This date is represented in ISO 8601 format.</td> </tr> <tr> <td>website</td> <td>string</td> <td>255</td> <td>Website of the institution.</td> </tr> <tr> <td>classes</td> <td>array[String]</td> <td>-</td> <td>Classes thought at the institution.</td> </tr> <tr> <td>is_main_employment</td> <td>boolean</td> <td>-</td> <td>True if this is your current employment, false otherwise.</td> </tr> </tbody></table> <h3 id="disciplines">Disciplines</h3> People are represented as an object with the following attributes: <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>string</td> <td>255</td> <td>Current research discipline. Possible values can be found by doing GET /disciplines.</td> </tr> <tr> <td>subdisciplines</td> <td>array[String]</td> <td>-</td> <td>Subdisciplines.</td> </tr> </tbody></table> <h3 id="image">Image</h3> People are represented as an object with the following attributes: <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Maximum length</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>width</td> <td>integer</td> <td>-</td> <td>Width of the photo.</td> </tr> <tr> <td>height</td> <td>integer</td> <td>-</td> <td>Height of the photo.</td> </tr> <tr> <td>original</td> <td>boolean</td> <td>-</td> <td>True if the this is the original photo that was uploaded.</td> </tr> <tr> <td>url</td> <td>string</td> <td>-</td> <td>The S3 URL of the file in storage. Auto-generated.</td> </tr> </tbody></table> <h2 id="retrieving-a-profile">Retrieving a profile</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/profiles/c0925ecf-4de0-3b61-ae9a-ebe5f7406327' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-profiles.1+json' { "id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "first_name": "Victor", "last_name": "Henning", "display_name": "Dr. Victor Henning", "link": "http://www.mendeley.com/profiles/victor-henning/", "research_interests": "Emotions, Decision Making, Theory of Reasoned Action, Intertemporal Choice, Motion Picture Economics", "academic_status": "Post Doc", "disciplines": [ { "name": "Computer and Information Science", "subdisciplines": [ "Software Engineering" ] } ], "photos": [ { "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29.png", "original": true }, { "height": 120, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-standard.jpg", "original": false }, { "width": 48, "height": 48, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-square.jpg", "original": false }, { "width": 256, "height": 256, "url": "http://s3.amazonaws.com/mendeley-photos/awaiting_square_256.png", "original": false } ], "verified": true, "location": { "latitude": 52.37, "longitude": 4.89, "name": "Amsterdam, Netherlands" }, "created_at": "2008-03-25T16:51:10.000Z", "education": [ { "institution": "Wissenschaftliche Hochschule für Unternehmensführung - Otto Beisheim Graduate School of Management", "degree": "Dipl.-Kfm. (MBA)", "start_date": "2000-10-01", "end_date": "2004-08-01", "website": "http://www.whu.edu" }, { "institution": "Université Libre de Bruxelles - Free University of Brussel", "degree": "", "start_date": "2002-01-01", "end_date": "2002-06-01", "website": "http://www.ulb.ac.be" }, { "institution": "Handelshøyskolen BI - Norwegian School of Management BI", "degree": "", "start_date": "2002-08-01", "end_date": "2002-12-01", "website": "http://www.bi.no" } ], "employment": [ { "institution": "Mendeley Ltd.", "position": "Co-Founder & CEO", "start_date": "2007-11-01", "website": "www.mendeley.com" }, { "institution": "Bauhaus-University of Weimar", "position": "Lecturer / Doctoral Student", "start_date": "2004-10-01", "end_date": "2010-12-01", "website": "www.uni-weimar.de", "classes": [ "The Kid Stays In The Picture: Economics of the Film Industry", "Guru*Lab: Production and Distribution of a Major German Motion Picture", "Guru*Talk: The Film Industry in the 21st Century", "Hedonic Consumption" ] }, { "institution": "Oliver Wyman Consulting", "position": "Summer Associate", "start_date": "2003-05-01", "end_date": "2003-08-01", "website": "www.oliverwyman.de" }, { "institution": "Revelation Records", "position": "Product Management / PR Dept.", "start_date": "2001-05-01", "end_date": "2001-08-01", "website": "www.revelation-records.com" }, { "institution": "Helkon Media AG", "position": "Film Production / Business Affairs Dept.", "start_date": "2002-06-01", "end_date": "2002-08-01", "website": "http://www.imdb.com/company/co0069136/" }, { "institution": "Sony Music Entertainment/Columbia Records", "position": "Junior A&R, Talent Scout", "start_date": "2000-01-01", "end_date": "2000-10-01", "website": "www.sonymusic.de" }, { "institution": "Elsevier", "position": "Co-Founder/CEO, Mendeley & VP Strategy", "start_date": "2013-04-01", "is_main_employment": true } ] } </code></pre> <pre><code class="highlight python">profile = mendeley.profiles.get('c0925ecf-4de0-3b61-ae9a-ebe5f7406327') print profile.display_name </code></pre> <pre><code class="highlight java">Profile profile = sdk.getProfile("c0925ecf-4de0-3b61-ae9a-ebe5f7406327"); </code></pre> Get a profile by ID. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/profiles/{id}</code> <h3 id="query-parameters">Query Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>UUID of a profile</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response with the profile. <h2 id="retrieving-profiles">Retrieving profiles</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/profiles' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-profiles.1+json' { "id": "c0925ecf-4de0-3b61-ae9a-ebe5f7406327", "first_name": "Victor", "last_name": "Henning", "display_name": "Dr. Victor Henning", "link": "http://www.mendeley.com/profiles/victor-henning/", "research_interests": "Emotions, Decision Making, Theory of Reasoned Action, Intertemporal Choice, Motion Picture Economics", "academic_status": "Post Doc", "disciplines": [ { "name": "Computer and Information Science", "subdisciplines": [ "Software Engineering" ] } ], "photos": [ { "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29.png", "original": true }, { "height": 120, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-standard.jpg", "original": false }, { "width": 48, "height": 48, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-square.jpg", "original": false }, { "width": 256, "height": 256, "url": "http://s3.amazonaws.com/mendeley-photos/awaiting_square_256.png", "original": false } ], "verified": true, "location": { "latitude": 52.37, "longitude": 4.89, "name": "Amsterdam, Netherlands" }, "created_at": "2008-03-25T16:51:10.000Z", "education": [ { "institution": "Wissenschaftliche Hochschule für Unternehmensführung - Otto Beisheim Graduate School of Management", "degree": "Dipl.-Kfm. (MBA)", "start_date": "2000-10-01", "end_date": "2004-08-01", "website": "http://www.whu.edu" }, { "institution": "Université Libre de Bruxelles - Free University of Brussel", "degree": "", "start_date": "2002-01-01", "end_date": "2002-06-01", "website": "http://www.ulb.ac.be" }, { "institution": "Handelshøyskolen BI - Norwegian School of Management BI", "degree": "", "start_date": "2002-08-01", "end_date": "2002-12-01", "website": "http://www.bi.no" } ], "employment": [ { "institution": "Mendeley Ltd.", "position": "Co-Founder & CEO", "start_date": "2007-11-01", "website": "www.mendeley.com" }, { "institution": "Bauhaus-University of Weimar", "position": "Lecturer / Doctoral Student", "start_date": "2004-10-01", "end_date": "2010-12-01", "website": "www.uni-weimar.de", "classes": [ "The Kid Stays In The Picture: Economics of the Film Industry", "Guru*Lab: Production and Distribution of a Major German Motion Picture", "Guru*Talk: The Film Industry in the 21st Century", "Hedonic Consumption" ] }, { "institution": "Oliver Wyman Consulting", "position": "Summer Associate", "start_date": "2003-05-01", "end_date": "2003-08-01", "website": "www.oliverwyman.de" }, { "institution": "Revelation Records", "position": "Product Management / PR Dept.", "start_date": "2001-05-01", "end_date": "2001-08-01", "website": "www.revelation-records.com" }, { "institution": "Helkon Media AG", "position": "Film Production / Business Affairs Dept.", "start_date": "2002-06-01", "end_date": "2002-08-01", "website": "http://www.imdb.com/company/co0069136/" }, { "institution": "Sony Music Entertainment/Columbia Records", "position": "Junior A&R, Talent Scout", "start_date": "2000-01-01", "end_date": "2000-10-01", "website": "www.sonymusic.de" }, { "institution": "Elsevier", "position": "Co-Founder/CEO, Mendeley & VP Strategy", "start_date": "2013-04-01", "is_main_employment": true } ] } </code></pre> <pre><code class="highlight python">profile = mendeley.profiles.get('c0925ecf-4de0-3b61-ae9a-ebe5f7406327') print profile.display_name </code></pre> <pre><code class="highlight java">Profile profile = sdk.getProfile("c0925ecf-4de0-3b61-ae9a-ebe5f7406327"); </code></pre> Get a profile by ID. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/profiles/{id}</code> <h3 id="query-parameters">Query Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>UUID of a profile</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response with the profile. <h2 id="retrieving-the-logged-in-user's-profile">Retrieving the logged-in user’s profile</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/profiles/me' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-profiles.1+json' { "id": "9930207c-c19f-3de0-b531-86bd4388fa94", "first_name": "Jenny", "last_name": "Johnson", "display_name": "Jenny Johnson", "email": "matt.thomson+jenny@mendeley.com", "link": "http://www.mendeley.com/profiles/jenny-johnson4/", "academic_status": "Librarian", "discipline": { "name": "Computer and Information Science", "subdisciplines": [ "Software Engineering" ] }, "disciplines": [ { "name": "Computer and Information Science", "subdisciplines": [ "Software Engineering" ] } ], "photos": [ { "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29.png", "original": true }, { "height": 120, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-standard.jpg", "original": false }, { "width": 48, "height": 48, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-square.jpg", "original": false }, { "width": 256, "height": 256, "url": "http://s3.amazonaws.com/mendeley-photos/awaiting_square_256.png", "original": false } ], "verified": false, "user_type": "normal", "created": "2014-08-26T15:24:45.000Z" } </code></pre> <pre><code class="highlight python">profile = mendeley.profiles.me print profile.display_name </code></pre> <pre><code class="highlight java">Profile profile = sdk.getMyProfile(); </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/profiles/me</code> <h3 id="returns">Returns</h3> A 200 OK response containing the profile of the logged-in user. <h2 id="updating-the-logged-in-user's-profile">Updating the logged-in user’s profile</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/profiles/me' \ -X PATCH \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Content-Type: application/vnd.mendeley-profile-amendment.1+json' \ --data-binary '{"title": "Dr.", "biography": "Knowledge Discovery products and R&D activities"}' { "id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "first_name": "Joyce", "last_name": "Stack", "display_name": "Dr. Joyce Stack", "email": "joyce.stack@mendeley.com", "link": "http://www.mendeley.com/profiles/joyce-stack1/", "institution": "Imperial College", "academic_status": "Other Professional", "discipline": { "name": "Computer and Information Science", "subdisciplines": [ "Software Engineering" ] }, "disciplines": [ { "name": "Computer and Information Science", "subdisciplines": [ "Software Engineering" ] } ], "photo": { "original": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29.png", "standard": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-standard.jpg", "square": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-square.jpg" }, "photos": [ { "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29.png", "original": true }, { "height": 120, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-standard.jpg", "original": false }, { "width": 48, "height": 48, "url": "http://s3.amazonaws.com/mendeley-photos/6a/bd/6abdab776feb7a1fd4e5b4979ea9c5bfc754fd29-square.jpg", "original": false }, { "width": 256, "height": 256, "url": "http://s3.amazonaws.com/mendeley-photos/awaiting_square_256.png", "original": false } ], "verified": true, "marketing": false, "user_type": "admin", "location": { "latitude": 51.513, "longitude": -0.123, "name": "London, United Kingdom" }, "created": "2013-10-08T09:26:16.000Z", "employment": [ { "institution": "Mendeley", "position": "Developer Outreach", "start_date": "2013-10-01", "website": "http://dev.mendeley.com", "is_main_employment": true } ], "title": "Dr.", "biography": "Knowledge Discovery products and R&D activities" } </code></pre> <pre><code class="highlight python">Not yet implemented </code></pre> <pre><code class="highlight java">Not yet implemented </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">PATCH https://api.mendeley.com/profiles/me</code> <h3 id="returns">Returns</h3> A successful update will return a HTTP 200 with the updated profile. <ul> <li>400 if the academic_status does not match a valid academic status as specified in <a href="#academic-statuses">Academic Statuses</a></li> <li>409 if the email is already in use </li> <li>422 is used for non-trivial error conditions such as multiple fields returning errors. </li> </ul> <h1 id="profile-search">Profile search</h1> The profiles returned have the same attributes as the <a href="#profiles">Profiles</a> API. <h2 id="search-by-query">Search by query</h2> Retrieve profiles which match general query terms. <pre><code class="highlight shell">curl 'https://api.mendeley.com/search/profiles?query=Politecnico+di+Milano' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-profile.1+json' [ { "id": "...", "first_name": "...", "last_name": "...", "display_name": "....", "link": "https://www.mendeley.com/profiles/.....", "folder": "...", "institution": "Student", "institution_details": { "name": "Student" }, "research_interests_list": [], "academic_status": "Student > Master", "discipline": { "name": "Computer Science", "subdisciplines": [] }, "disciplines": [ { "name": "Computer Science", "subdisciplines": [] } ], "photo": {}, "photos": [], "verified": true, "user_type": "normal", "created": 1234567891011, "employment": [ { "id": "....", "institution_details": { "name": "Student" }, "institution": "Student", "position": "Politecnico di Milano", "start_date": [ 1970, 1, 1 ] } ], "visibility": "all" } ] </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/search/profiles?query=Politecnico+di+Milano</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>query</td> <td>string</td> <td>Query terms, which match any field in the profile, e.g. name, discipline, etc (required).</td> </tr> <tr> <td>limit</td> <td>int</td> <td>The maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 100.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 response containing a paginated list of the matching profiles. <h1 id="trash">Trash</h1> The documents returned have the same attributes as the <a href="#documents">Documents</a> API. <h2 id="retrieve-a-trashed-document">Retrieve a trashed document</h2> Retrieves a document from the trash. <pre><code class="highlight shell">curl 'https://api.mendeley.com/trash/183217fc-9c61-34d1-be8b-996556410ccb' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' { "id": "183217fc-9c61-34d1-be8b-996556410ccb", "title": "MapReduce", "type": "journal", "authors": [ { "first_name": "Jeffrey", "last_name": "Dean" }, { "first_name": "Sanjay", "last_name": "Ghemawat" } ], "year": 2008, "source": "Communications of the ACM", "identifiers": { "issn": "00010782", "pmid": "11687618", "doi": "10.1145/1327452.1327492", "isbn": "9781595936868" }, "created": "2013-10-16T09:24:45.000Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "last_modified": "2014-06-19T10:12:05.000Z", "abstract": "MapReduce is a programming model and an associated implementation for processing ......" } </code></pre> <pre><code class="highlight python">doc = mendeley.trash.get('183217fc-9c61-34d1-be8b-996556410ccb') print doc.title </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/trash/{id}</code> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document.</td> </tr> <tr> <td>view</td> <td>string</td> <td>includes core document fields plus additional fields.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 200 OK response containing a single document. <h2 id="retrieve-all-trashed-documents">Retrieve all trashed documents</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/trash' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-document.1+json' [ { "id": "183217fc-9c61-34d1-be8b-996556410ccb", "title": "MapReduce", "type": "journal", "authors": [ { "first_name": "Jeffrey", "last_name": "Dean" }, { "first_name": "Sanjay", "last_name": "Ghemawat" } ], "year": 2008, "source": "Communications of the ACM", "identifiers": { "issn": "00010782", "pmid": "11687618", "doi": "10.1145/1327452.1327492", "isbn": "9781595936868" }, "created": "2013-10-16T09:24:45.000Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "last_modified": "2014-06-19T10:12:05.000Z", "abstract": "MapReduce is a programming model and an associated implementation for processing ......" }, { "id": "e76d1e0d-c3fc-39af-83b4-a10e3d42cb28", "title": "Antler growth and extinction of Irish elk", "type": "journal", "authors": [ { "first_name": "Ron A", "last_name": "Moen" }, { "first_name": "John", "last_name": "Pastor" }, { "first_name": "Yosef", "last_name": "Cohen" } ], "year": 1999, "source": "Evolutionary Ecology Research", "identifiers": { "isbn": "1522-0613" }, "created": "2014-01-15T12:38:57.000Z", "profile_id": "4afc0c0f-88ab-3aed-a20a-f50934fc83b1", "last_modified": "2014-06-30T14:24:09.000Z", "abstract": "Adult male Irish elk (Megaloceros giganteus) grew the largest antlers of any extinct or extant cervid...." }, ] </code></pre> <pre><code class="highlight python">for doc in mendeley.trash.iter(): print doc.title </code></pre> <pre><code class="highlight java">DocumentList documentList = sdk.getTrashedDocuments(); List<Document> docs = documentList.documents; Page next = documentList.next; </code></pre> Retrieves all documents in the trash. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/trash</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>view</td> <td>string</td> <td>includes core document fields plus additional fields.</td> </tr> <tr> <td>group_id</td> <td>string</td> <td>the id of the group that the document belongs to. If not supplied returns users documents.</td> </tr> <tr> <td>modified_since</td> <td>string</td> <td>returns only documents modified since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>deleted_since</td> <td>string</td> <td>returns only documents deleted since this timestamp. Should be supplied in ISO 8601 format</td> </tr> <tr> <td>limit</td> <td>string</td> <td>the maximum number of items on the page. If not supplied, the default is 20. The largest allowable value is 500</td> </tr> <tr> <td>order</td> <td>string</td> <td>sort order</td> </tr> <tr> <td>sort</td> <td>string</td> <td>field to sort on</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A paginated collection of documents. <h2 id="restoring-a-document">Restoring a document</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/trash/183217fc-9c61-34d1-be8b-996556410ccb/restore' -X POST \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight python">restored_doc = doc.restore() </code></pre> <pre><code class="highlight java">sdk.restoreDocument("183217fc-9c61-34d1-be8b-996556410ccb"); </code></pre> Restores a document from the trash. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">POST /trash/{id}/restore</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response. <h2 id="deleting-a-trashed-document">Deleting a trashed document</h2> <pre><code class="highlight shell">curl 'https://api.mendeley.com/trash/183217fc-9c61-34d1-be8b-996556410ccb' \ -X DELETE \ -H 'Authorization: Bearer <ACCESS_TOKEN>' </code></pre> <pre><code class="highlight python">doc.delete() </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> Permanently deletes a document from the trash. <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">DELETE /trash/{id}</code> <h3 id="url-parameters">URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>string</td> <td>Identifier (UUID) of the document.</td> </tr> </tbody></table> <h3 id="returns">Returns</h3> A 204 No Content response. <h1 id="subject-areas">Subject Areas</h1> <h2 id="retrieve-all-subject-areas">Retrieve all subject areas</h2> Retrieves all subject areas. <pre><code class="highlight shell">curl 'https://api.mendeley.com/subject_areas' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-subject-area.1+json' [ { "name": "Agricultural and Biological Sciences", "subdisciplines": [] }, { "name": "Arts and Humanities", "subdisciplines": [] }, { "name": "Biochemistry, Genetics and Molecular Biology", "subdisciplines": [] }, { "name": "Business, Management and Accounting", "subdisciplines": [] }, { "name": "Chemical Engineering", "subdisciplines": [] }, { "name": "Chemistry", "subdisciplines": [] }, { "name": "Computer Science", "subdisciplines": [] }, { "name": "Decision Sciences", "subdisciplines": [] }, { "name": "Design", "subdisciplines": [] }, { "name": "Earth and Planetary Sciences", "subdisciplines": [] }, { "name": "Economics, Econometrics and Finance", "subdisciplines": [] }, { "name": "Energy", "subdisciplines": [] }, { "name": "Engineering", "subdisciplines": [] }, { "name": "Environmental Science", "subdisciplines": [] }, { "name": "Immunology and Microbiology", "subdisciplines": [] }, { "name": "Linguistics", "subdisciplines": [] }, { "name": "Materials Science", "subdisciplines": [] }, { "name": "Mathematics", "subdisciplines": [] }, { "name": "Medicine and Dentistry", "subdisciplines": [] }, { "name": "Neuroscience", "subdisciplines": [] }, { "name": "Nursing and Health Professions", "subdisciplines": [] }, { "name": "Pharmacology, Toxicology and Pharmaceutical Science", "subdisciplines": [] }, { "name": "Philosophy", "subdisciplines": [] }, { "name": "Physics and Astronomy", "subdisciplines": [] }, { "name": "Psychology", "subdisciplines": [] }, { "name": "Social Sciences", "subdisciplines": [] }, { "name": "Sports and Recreations", "subdisciplines": [] }, { "name": "Veterinary Science and Veterinary Medicine", "subdisciplines": [] } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/subject_areas</code> <h3 id="returns">Returns</h3> A 200 OK response containing a all subject areas. <h1 id="user-roles">User Roles</h1> <h2 id="retrieve-all-user-roles">Retrieve all user roles</h2> Retrieves all user roles. <pre><code class="highlight shell">curl 'https://api.mendeley.com/user_roles' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Accept: application/vnd.mendeley-user-role.1+json' [ { "description": "Lecturer" }, { "description": "Lecturer > Senior Lecturer" }, { "description": "Librarian" }, { "description": "Other" }, { "description": "Professor" }, { "description": "Professor > Associate Professor" }, { "description": "Researcher" }, { "description": "Student > Bachelor" }, { "description": "Student > Doctoral Student" }, { "description": "Student > Master" }, { "description": "Student > Ph. D. Student" }, { "description": "Student > Postgraduate" } ] </code></pre> <pre><code class="highlight python">Not implemented. </code></pre> <pre><code class="highlight java">Not implemented. </code></pre> <h3 id="http-request">HTTP Request</h3> <code class="prettyprint">GET https://api.mendeley.com/user_roles</code> <h3 id="returns">Returns</h3> A 200 OK response containing a all user roles. <h1 id="errors">Errors</h1> The Mendeley API uses standard <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP codes</a> to provide the clients with information about whether the request has been successful or not. In some cases we have used extensions to HTTP such as <a href="http://tools.ietf.org/html/rfc4918">RFC-4918</a> <table><thead> <tr> <th>Error Code</th> <th>Meaning</th> </tr> </thead><tbody> <tr> <td>200</td> <td>OK – The request was successful</td> </tr> <tr> <td>201</td> <td>Created – The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the Location header.</td> </tr> <tr> <td>204</td> <td>No content – The request was successful and no extra information will be provided in the body of the response.</td> </tr> <tr> <td>400</td> <td>Bad Request – The request you sent to the server is invalid.</td> </tr> <tr> <td>401</td> <td>Unauthorized – Your API key is wrong</td> </tr> <tr> <td>403</td> <td>Forbidden – Access to the resource is not allowed.</td> </tr> <tr> <td>404</td> <td>Not Found – The resource you were requesting cannot be found.</td> </tr> <tr> <td>405</td> <td>Method Not Allowed – The HTTP method (GET/POST/PUT/PATCH/DELETE) is not valid for this resource.</td> </tr> <tr> <td>406</td> <td>Not Acceptable – The media type in the Accept header is not valid for this resource.</td> </tr> <tr> <td>409</td> <td>Conflict – The resource conflicts with one that already exists.</td> </tr> <tr> <td>412</td> <td>Precondition Failed</td> </tr> <tr> <td>415</td> <td>Unsupported Media Type – The media type in the Content-Type header is not valid for this resource.</td> </tr> <tr> <td>422</td> <td>Unprocessable Entity – The server understands the request entity but was semantically erroneous. See <a href="http://tools.ietf.org/html/rfc4918">RFC-4918</a></td> </tr> <tr> <td>429</td> <td>Too Many Requests - We’ve rate limited you. Contact api-support@mendeley.com.</td> </tr> <tr> <td>500</td> <td>Internal Server Error – We had a problem with our server. Try again later.</td> </tr> <tr> <td>503</td> <td>Service Unavailable – We’re temporarily offline for maintenance. Please try again later.</td> </tr> </tbody></table> </div> <div class="dark-box"> <div class="lang-selector"> <a href="#" data-language-name="shell">cURL</a> </div> </div> </div> </body> </html>