Populate user interface controls for with document types

…

 curl 'https://api.mendeley.com/search/catalog?query=whales' \
					-X GET \
					-H 'Authorization: Bearer ' \
					-H 'Accept: application/vnd.mendeley-document.1+json'

A list of catalog documents is returned from the API resource but only the first item retunred is displayed for brevity. The search query has found all papers with the word whales in any of the fields. Statistics aggregated from all Mendeley users have been provided also.

Advanced Search

If you have any metadata about the papers you are searching for then you can use the more advanced searching features. The more fields that you provide then the better the results.

At least one of title, author, source or abstract 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.

If you would like to filter down the results to a particular year then you can use the min_year and max_year parameters. Setting either a minimum or maximum year excludes documents which do not have a year defined.

Setting the open_access=true will return just the open access journals.

Advanced Search Operators

If you're having trouble narrowing down your search results, you might want to try using our search operators, which you can use to fine-tune your search query. Follow the examples provided below and edit in your own search terms to see the best results.

openssl sha1 sample.pdf SHA1(/path/to/sample.pdf)= b0b75611366f6a5af8dd906c935f38bf3f509751
curl -H "Authorization: Bearer MSwxNDA5…a1BJUTQ" "https://api.mendeley.com/catalog?filehash=b0b75611366f6a5af8dd906c935f38bf3f509751"

 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     

GET /documents

{
  "id": "1137042a-8c30-3cd6-a7f6-7d5f1f6c450d",
  …
  "file_attached": true,
  …
}

GET /documents?group_id=77dd7020-e2f6-3fb3-94ea-3cea11555af2

POST /documents

{
  "group_id":"77dd7020-e2f6-3fb3-94ea-3cea11555af2",
  "title": "Map Reduce: Simplified data processing on large clusters",
  "type": "journal",
  "authors": [
    {
      "first_name": "Jeffrey",
      "last_name": "Dean"
    },
    {
      "first_name": "Sanjay",
      "last_name": "Ghemawat"
    }
  ],
  "year": 2008
}

GET /files?document_id=1137042a-8c30-3cd6-a7f6-7d5f1f6c450d

An empty array in the response indicates the document does not have files attached.

To determine if documents in a collection may have files attached, inspect the file_attached member of a document. Request the documents with a client or all value for the view HTTP query string field.

{
  "id": "1137042a-8c30-3cd6-a7f6-7d5f1f6c450d",
  …
  "file_attached": true,
  …
}

GET /files/1137042a-8c30-3cd6-a7f6-7d5f1f6c450d

The successful API response will have:

• 303 See Other HTTP status
• HTTP Location header containing a link to the file location
• an empty body

The Location header contains a URL value to download the media file. The URL will only remain valid for a short period of time so your application should not cache these values and should only request a location just before the application intends to download the media file. The URL location, format and authorization mechanism are subject to change and your application must not attempt to parse the download URL.

HTTP/1.1 303 See Other
Location: Location: https://mendeley-files.s3.amazonaws.com/0c/07/0c071302a58db1e471c0923deeb9f47c5cd2f63d?response-content-disposition%3Dattachment%3Bfilename%3D%E2%80%9CReport.pdf%22&response-content-type=application%2Fpdf&AWSAccessKeyId=AKIAJGTIMKBSM3FEA25A&Expires=1409062238&Signature=aLU%2F%2FaqPGYgmiTCgHuKT%2B%2F%2BgWNk%3D
Content-Length: 0

Once the file has completely downloaded to local storage, your application should ensure file integrity by comparing the file size or a SHA1 hash to the API response file metadata.

// API response for file:
{
    "id":"76d0efcb-2690-507f-07b7-21234c617b03",
    "document_id":"1137042a-8c30-3cd6-a7f6-7d5f1f6c450d",
    "mime_type":"application/pdf",
    "file_name":"Report.pdf",
    "size":6123,
    "filehash":"0c071302a58db1e471c0923deeb9f47c5cd2f63d"
}


stat -f %z report.pdf
6123
openssl sha1 report.pdf
SHA1(/path/to/report.pdf)= 0c071302a58db1e471c0923deeb9f47c5cd2f63d

POST /files HTTP/1.1
Authorization: Bearer MSwxNDA5MDU0ODM0MTQy…zFJd0liZHpSMVU
Link: <https://api.mendeley.com/documents/1137042a-8c30-3cd6-a7f6-7d5f1f6c450d>; rel="document"
Content-Disposition: attachment; filename="report.pdf"
Content-Type: application/pdf
Content-Length: 6123

[binary data in the request body]

The request HTTP header values should be:

Link

The document relationship must contain the URL to the intended parent document.

Content-Disposition

This must be attachment and your application can use the filename qualifier to suggest a filename.

Content-Type

The Internet MIME type for the uploaded file. Unrecognized MIME types are persisted and delivered as binary data: application/octet-stream.

Content-Length

The number of bytes in the request's body.

A successful file upload generates an HTTP response with:

• an HTTP status of 201 Created.
• an HTTP Location header containing the URL of the newly created file.
• a body containing the JSON representation of the newly created file.

1. Request the group using GET /groups/{id}.
2. Retrieve the identifier value for the member owning_profile_id from the response.
3. Use the identifier to request the profile information using GET /profiles/{id}.

POST /folders

{
  "name":"Untitled folder",
  "parent_id":"95342445-ab75-42ba-b98f-888bbe543c0f"
}

POST /folders

{
  "name":"デジタルコンテンツ",
  "group_id":"9ab2887c-9b1c-38d7-a64a-3491306362a7"
}

PATCH /folders/9ab2887c-9b1c-38d7-a64a-3491306362a7
{
  "parent_id":"95342445-ab75-42ba-b98f-888bbe543c0f"
}

PATCH /folders/9ab2887c-9b1c-38d7-a64a-3491306362a7

{
  "parent_id":"root"
}

Populate user interface controls for with document types

…
<select id="doc_type_popup" onchange="docTypeDidChange(this);"></select> <!-- the popup menu in the HTML -->

…
function processDocumentTypesResponse(xmlhttp) {
    // in the successful response to an AJAX request for /document_types
    data = JSON.parse(xmlhttp.responseText);

    popup_menu = document.getElementById("doc_type_popup");
    for (i=0;i<types.length;i++) {
        var option = document.createElement("option");
        option.textContent = types[i].description; // set the label visible to the user
        option.value = types[i].name; // set the data value
        popup_menu.appendChild(option);
    }
}

function docTypeDidChange(sender) {
    selectedDocument.type = sender.value; // assume selectedDocument is a JS object
}