Retrieving an Article Note by ID

The Dynamic Health EBSCO Partner API GET /content/article-notes endpoint can be used to return a specific Dynamic Health article note for the given customer. The request must include the customerId query parameter and an 'Authorization' token for the request header. You can access a specific article note by passing the optional articleId query parameter.

Basic Retrieving of an Article Note by ID

To Perform an Article Note Search by ID (example):

Gather the following information for the request:

  • An access token. Please see Using the Client Credentials Grant for further information.
  • The customer id for the client that you wish to search for.
  • The article id that you would like the note for.

Request

GET https://apis.ebsco.com/medsapi-partner-dynamic-health/v1/content/article-notes?customerId=customer-one&articleId=T12345

Response

{
  "_metadata": {
    "links": [
      {
        "rel": "self",
        "href": "https://apis.ebsco.com/medsapi-partner-dynamic-health/v1/content/article-notes?customerId=customer-one&articleId=T12345"
      }
    ],
    "totalItems": 1
  },
  "items": [
    {
      "customer": {
        "id": "customer-one"
      },
      "text": "this is a new note",
      "lastUpdate": {
        "timestamp": "2019-10-28T18:51:18.614Z",
        "username": "msmith",
        "firstName": "Mary",
        "lastName": "Smith"
      },
      "article": {
        "id": "T12345"
      }
    }
  ]
}

Error Response Codes

The Dynamic Health GET an article note endpoint can return one of the error response codes.