Retrieving an Article by ID GET
The Dynamic Health API GET an article by article ID endpoint returns the requested article. Before you can execute an article call, you must have an 'Authorization' token which is to be entered into the request header.
Basic Retrieval by ID
To Perform an Article Request (example):
Gather the following information for the request:
- An access token. Please see Using the Client Credentials Grant for further information.
- The ID of the requested article.
Request
GET https://apis.ebsco.com/medsapi-dynamic-health/v1/content/articles/{id}
Response - Common Shape
The common shape response is used for all articles except FA Davis Drugs (pubTypeId: fadrgu) articles. All article responses will first contain an id, title, slug, and links field. Additional fields may be returned in the metadata. The remaining fields for the common shape response are shown below.
{
"id": "t1530546042270",
"title": "Gait Belt Utilization for Ambulation",
"slug": "/skills/gait-belt-utilization-for-ambulation",
"links": [
{
"rel": "self",
"href": "https://apis.ebsco.com/medsapi-dynamic-health/v1/content/articles/t1530546042270"
}
],
"metadata": {
"DC.Type": "topic",
"DC.Title": "Gait Belt Utilization for Ambulation",
"abstract": "Promoting safe patient mobility using the assistive device",
"DC.Format": "XHTML",
"copyright": "(C) Copyright 2020",
"DC.Language": "en",
"description": "Promoting safe patient mobility using the assistive device",
"DC.Publisher": "EBSCO Publishing",
"DC.Identifier": "GUID-8F887103-7A62-4FA3-9AE4-BBD23310BE87",
"DC.Date.Created": "2018-06-29",
"DC.Date.Revised": "2019-07-29",
"DC.rights.owner": "(C) Copyright 2020"
},
"toc": [
{
"title": "Procedure",
"anchor": "PROCEDURE-WRAPPER",
"children": [
{
"title": "Supplies",
"anchor": "SUPPLIES"
}
]
}
],
"sections": [
{
"anchor": "PROCEDURE-WRAPPER",
"title": "Procedure",
"content": "",
"children": [
{
"anchor": "SUPPLIES",
"content": "",
"title": "Supplies"
}
]
}
],
"ancillary": {
"pubType": {
"id": "skills"
},
"pubDate": "2018-06-29",
"revisedDate": "2019-07-29",
"description": "Promoting safe patient mobility using the assistive device",
"checklist": [
{
"anchor": "GUID-0F92EBD8-09F3-4CF5-BBC3-3722E5F6E038__GUID-77FE98B5-96E3-49F2-B0BC-AD01B69A6BBE",
"content": "<div>html</div>",
"title": "Pre-Procedure Steps"
}
],
"glossary": {
"anchor": "GUID-0FD93E05-5A58-460E-A875-DECF39E9C5D2",
"title": "Glossary",
"sections": [
{
"anchor": "GUID-DC4C8487-B3A7-429B-ADF2-5FDE8D98C96A",
"content": "<div>html</div>",
"title": "peristalsis"
}
]
},
"multimedia": [
{
"content": [
{
"title": "Gait Belt Utilization for Ambulation. ",
"publicId": "EBSCOHealth/CCMS/NAH/videos/dc59886ab832cab2ea72b70c324287e1",
"copyright": "Copyright ©2019, EBSCO Information Services",
"mediaHost": "cloudinary",
"description": "Steps 5-23.",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/f_mp4/v1/EBSCOHealth/CCMS/NAH/videos/dc59886ab832cab2ea72b70c324287e1.mp4?__cld_token__=exp=1660160350~hmac=cd139fc4a122dfc6b86cba5a2b6122ac275f92da40a7435d658704775f27d576"
}
]
}
],
"mediaType": "video"
}
],
"contributors": {
"revisedDate": "2018-07-17",
"acpContributor": "American College of Physicians",
"authors": [...],
"editors": [
{
"degrees": "MD, FACC, FHFSA, FAHA",
"firstName": "Anekwe E.",
"lastName": "Onwuanyi",
"affiliationText": "\"The Skin Clinic, Massachusetts, United States",
"conflictsText": "Dr. Elpern declares no relevant conflicts of\\n interest.",
"degrees": "MD, MPH, FACP",
"label": "Topic Editor"
}
],
"reviewers": [...]
},
"supplemental": {
"anchor": "GUID-A951E562-1BBE-41CB-B43D-53D46F4FEFD7",
"title": "Supplemental Information",
"sections": [
{
"anchor": "GUID-A951E562-1BBE-41CB-B43D-53D46F4FEFD7__GUID-5A4B56A8-7993-4A5D-92F3-9F3E4602F89B",
"content": "",
"title": "Contraindications to Gait Belt Use"
}
]
}
}
}
Response - FA Davis Drugs
FA Davis Drug responses have a different response shape consisting of the following fields: id, title, slug, links, and data.
{
"id": "fd000649",
"links": [
{
"rel": "self",
"href": "https://apis.ebsco.com/medsapi-dynamic-health/v1/content/articles/fd000649"
}
],
"title": "glycopyrrolate, oral inhalation",
"slug": "/drug-monographs/glycopyrrolate-oral-inhalation",
"data": {
"an": "an:dh:fd000649",
"metadata": {
"mono.id": "glycopyrrolateoralinhalation",
"DC.Title": "glycopyrrolate, oral inhalation",
"drug.type": "drug.monograph",
"search.id": "glycopyrrolate, oral inhalation"
},
"toc": [
{
"title": "Indications",
"reference": "d1e21"
},
{
"title": "Action",
"reference": "d1e24"
}
...
],
"content": [
{
"id": "d1e21",
"data": "<div class=\"body\">Maintenance treatment of COPD. </div>",
"title": "Indications"
},
{
"id": "d1e24",
"data": "<div class=\"body\">Inhibits the action of acetylcholine at the muscarinic receptor, M3, in the bronchial\n smooth muscle, leading to bronchodilation. \n <p class=\"p\"><strong class=\"ph b\">Therapeutic Effects:</strong>Bronchodilation with decreased airflow obstruction. </p>\n </div>",
"title": "Action"
},
...
],
"ancillary": {
"pubType": "fadrug",
"headerMetadata": {
"title": {
"firstChar": "G",
"pronunciation": "glye-koe-<strong class=\"ph b\">pye</strong>-roe-late"
},
"additionalMetadata": [
{
"subElements": [
{
"content": [
"Lonhala Magnair",
"Seebri Neohaler"
]
}
]
},
{
"title": "Classifications",
"subElements": [
{
"content": [
"bronchodilators"
],
"heading": "Therapeutic"
},
{
"content": [
"anticholinergics"
],
"heading": "Pharmacologic"
}
]
}
]
}
}
}
}
Image and Video Responses in Articles
Article responses can include images and/or videos. These include the title, copyright and a link to the actual image or video. The image URL is a link to a full resolution image that is optimized for the browser making the request. The link is valid for 24 hours and should not be cached. The caller can alternately request that secure URLs (https) be returned by specifying that secure=true in the request. Image size(s) and poster size(s) of the video can also be requested.
Request for Secure Image and Video Size Links
GET https://apis.ebsco.com/medsapi-dynamic-health/v1/content/articles/t1530546042270?secure=true&imageSize=small&imageSize=full&posterSize=small&posterSize=large
Response
{
"id": "t1530546042270",
"links": [
{
"rel": "self",
"href": "https://apis.ebsco.com/medsapi-dynamic-health/v1/content/articles/t1530546042270"
}
],
"title": "Using a Gait Belt for Ambulation",
"slug": "/nursing-skills/using-a-gait-belt-for-ambulation",
"toc": [... ],
"metadata": {
"abstract": "Promoting safe patient mobility using the assistive device",
"copyright": "(C) Copyright 2022",
"description": "Promoting safe patient mobility using the assistive device",
"DC.Type": "topic",
"DC.Title": "Using a Gait Belt for Ambulation",
"DC.Format": "XHTML",
"DC.Language": "en",
"DC.Publisher": "EBSCO Publishing",
"DC.Identifier": "GUID-8F887103-7A62-4FA3-9AE4-BBD23310BE87",
"DC.Date.Created": "2018-06-29",
"DC.Date.Revised": "2021-05-24",
"DC.rights.owner": "(C) Copyright 2022"
},
"sections": [...],
"pubDate": "2018-06-29",
"revisedDate": "2021-05-24",
"checklist": [...],
"description": "Promoting safe patient mobility using the assistive device",
"supplemental": {...]
},
"multimedia": [
{
"mediaType": "video",
"content": [
{
"title": "Gait Belt Utilization for Ambulation. ",
"publicId": "EBSCOHealth/CCMS/NAH/videos/dc59886ab832cab2ea72b70c324287e1",
"copyright": "Copyright, EBSCO Information Services",
"mediaHost": "cloudinary",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/f_mp4/v1/EBSCOHealth/CCMS/NAH/videos/dc59886ab832cab2ea72b70c324287e1.mp4?__cld_token__=exp=1660160350~hmac=cd139fc4a122dfc6b86cba5a2b6122ac275f92da40a7435d658704775f27d576"
},
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/t_s200/f_jpg/v1/EBSCOHealth/CCMS/NAH/videos/dc59886ab832cab2ea72b70c324287e1.mp4?__cld_token__=exp=1660160350~hmac=4ea5230b394a808240630bd80c55068ded9cdeab7462551f7085eb223acedd99",
"posterSize": "small",
"type": "poster"
},
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/video/authenticated/t_s1000/f_jpg/v1/EBSCOHealth/CCMS/NAH/videos/dc59886ab832cab2ea72b70c324287e1.mp4?__cld_token__=exp=1660160350~hmac=e96563aff6a83f32c1b04f3fc15eff94f74d8aab2878580528386ae1fa97330f",
"posterSize": "large",
"type": "poster"
}
]
}
]
},
{
"mediaType": "image",
"content": [
{
"title": "Providing Additional Support for Patient Gait Belt Utilization. ",
"publicId": "EBSCOHealth/CCMS/NAH/images/124910657",
"copyright": "Copyright ©2019, EBSCO Information Services",
"mediaHost": "cloudinary",
"links": [
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/t_s200/f_auto/v1/EBSCOHealth/CCMS/NAH/images/124910657?__cld_token__=exp=1660160350~hmac=b266d09be28941a2c112bc1ec69b9797feb1a1d9907660cb067a695ab2732d82",
"imageSize": "small"
},
{
"rel": "external",
"href": "https://media.ebsco.healthcare/eis-live/image/authenticated/f_auto/v1/EBSCOHealth/CCMS/NAH/images/124910657?__cld_token__=exp=1660160350~hmac=182ca8a7f95b1e6262d4e1374cde676b2835662b6f1bbc5185101cb40bf6ea92",
"imageSize": "full"
}
]
}
]
}
]
}
}
Error Response Codes
The Dynamic Health get an article by ID endpoint can return one of the error response codes.
Updated about 1 month ago