Retrieving an Article by ID
The NAH Reference Center API GET an article by article ID endpoint returns an article by an article ID. Before you can execute an article call, you must have an 'Authorization' token to into the request header.
Basic Retrieving of an Article 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. This will be the t-number.
Request
GET https://apis.ebsco.com/medsapi-ref-ctr/v1/content/articles/t90416Response
The response below is used for all NAH Reference Center articles. Not all fields will be returned. All article responses will first contain an id, title, and links field. Additional fields may be returned in the metadata. Article responses can include images and/or videos. These can include the title, copyright and a link to the actual image or video. By default, 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. Image size(s) and poster size(s) of the video can be requested. The link will include the file type. If a video is returned and posterSize is specified, it will return a poster of the video in the requested size.
{
"id": "t904163",
"title": "Disseminated Intravascular Coagulation (DIC): Managing in Patients with Cancer",
"links": [
{
"rel": "self",
"href": "https://apis.ebsco.com/medsapi-ref-ctr/v1/content/articles/t904163"
}
],
"metadata": {
"title": "Disseminated Intravascular Coagulation (DIC): Managing in Patients with Cancer",
"description": "Disseminated Intravascular Coagulation (DIC): Managing in Patients with Cancer",
"revised": "2016-02-26T00:00:00.000Z",
"lastModifiedDate": "2017-06-20T00:00:00.000Z",
"DC.Format": "XHTML",
"DC.Language": "en",
"DC.Identifier": "GUID-85695AD4-011B-424F-8F37-0340C895D843",
"alternateTerms": [
"Managing in Patients with Cancer: Disseminated Intravascular Coagulation (DIC)"
],
"copyright": "(C) Copyright 2024",
"dbAn": "0000904163",
"publisherPlace": "Ipswich, Massachusetts",
"patientAgeMin": "0",
"patientAgeMax": "120",
"gender": [
"Male",
"Female"
],
"rehabSpecialtySlp": [
"Learning Disabilities",
"Pediatric Genetic and/or Neurological Disorders"
],
"rehabSpecialtyPtot": [
"Neurological Rehabilitation",
"Pediatric Rehabilitation"
],
"nursingSpecialty": [
"Oncologic Nursing"
],
"visible": "True",
"seeReferences": [
"Managing in Patients with Cancer: Disseminated Intravascular Coagulation (DIC)"
],
"subject.major": [
"Cancer Patients//"
],
"subject.minor": [
"Education, Continuing (Credit)//"
],
"medicalCodes.ICD-9": [
"286.6"
],
"medicalCodes.ICD-9-CM-D": [
"294.9",
"300.9"
],
"medicalCodes.ICD-9-CM-P": [
"39.65"
],
"medicalCodes.ICD-10-CM": [
"D65"
],
"medicalCodes.ICD-10-CM-D": [
"F99"
],
"medicalCodes.ICD-10-CM-P": [
"5A15223"
],
"medicalCodes.ICD-10-CAN": [
"D65"
],
"medicalCodes.RxNorm": [
"152061",
"194722"
],
"medicalCodes.SNOMED": [
"67406007"
],
"medicalCodes.LOINC": [
"2106-3"
]
},
"toc": [
{
"title": "What is Managing Disseminated Intravascular Coagulation (DIC) in Patients with Cancer?",
"anchor": "GUID-361EE199-381F-4E2B-9E1E-F19476F7BE0E__WHAT_IS_PROCEDURE_"
}
],
"sections": [
{
"anchor": "GUID-361EE199-381F-4E2B-9E1E-F19476F7BE0E__PDF-IGNORE",
"content": "<div class=\"section\"><span class=\"data\" property=\"sec-type\">pdf-ignore</span><p class=\"p\"><strong class=\"ph b\"><a property=\"ArticleLink\" class=\"xref\" href=\"article://T904164\" target=\"_blank\">Link to Skill Competency Checklist</a></strong></p><p class=\"p\"><strong class=\"ph b\"><a property=\"ArticleLink\" class=\"xref\" href=\"article://T910855\" target=\"_blank\">Link to Interactive Skill Competency Checklist</a></strong></p></div>"
}
],
"ancillary": {
"pubType": {
"id": "NursingPracticeAndSkill"
},
"contributors": {
"authors": [
{
"contributorType": "authors",
"degrees": "RN, BSN, OCN",
"firstName": "Morgan Nicole",
"lastName": "Holle"
}
],
"editors": [
{
"contributorType": "editors",
"degrees": "RN, PhD, FAAN",
"firstName": "Diane",
"lastName": "Pravikoff"
}
],
"reviewers": [
{
"contributorType": "reviewers",
"degrees": "RN, MSN, CCRN",
"firstName": "Kathleen",
"lastName": "Walsh"
}
]
},
"multimedia": [
{
"mediaType": "image",
"content": [
{
"links": [
{
"rel": "external",
"href": "http://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/f_auto/v1/EBSCOHealth/CCMS/Ref_Centers/images/I500812?__cld_token__=exp=1716647249~hmac=3fa7b762a99b09e19"
}
],
"title": "Units of Packed Red Blood Cells, Fresh Frozen Plasma, and Platelets",
"copyright": "Copyright© 2014, EBSCO Information Services.",
"mediaHost": "Cloudinary",
"description": "Procedures / Units of packed red blood cells (RBCs), fresh frozen plasma (FFP), and platelets.",
"publicId": "EBSCOHealth/CCMS/Ref_Centers/images/I500812"
}
]
}
]
}
}Media within Articles
Access to Multimedia Assets
Article responses may include references to multimedia assets within the multimedia section of the response payload.
Each multimedia entry can include the following metadata:
- Title – The name or caption associated with the media asset
- Copyright – Copyright attribution information
- Media URL – A link to the associated image or video asset
Media URL Behavior
- The media URL provides access to a full-resolution image or video.
- The URL is temporary and valid for 24 hours from the time the article response is generated.
- Clients must not cache the URL.
Access and Refresh
- If access to the media asset is required after the 24-hour validity period, the client must re-request the article through the API to obtain a new media URL.
- No additional authentication is required to retrieve the media asset once the URL has been issued.
Specifying Image and Video Image Sizes
Links to images of varying sizes may be returned in the article response. To specify the image size, add one or more imageSize query parameters to the call. small (200w), medium (500w) and large (1000w) image sizes are supported. Also, the full image size is supported and is the default if no image size was specified. A still image of the video (aka thumbnail or poster) can also be returned with the video. To specify the size, add one or more posterSize parameters to the call. Small, medium, large and full sized images of the video will be returned. To distinguish the video and video link in the response, a type parameter is added and is set to "poster". No poster is returned unless posterSize is provided.
| Parameter Name | Description |
|---|---|
| secure | Set to true to return secure https URLs for media links. (true is default) |
| imageSize | Returns the requested size(s): small, medium, large, full. |
| posterSize | Returns the requested size(s) for poster of the video links: small, medium, large or full. |
Image Link Section when imageSize is Requested
When imageSize is requested, the image link will look the same as in the above response, but with the addition of imageSize.
"links": [
{
"rel": "external",
"imageSize": "small",
"href": "http://media.ebsco.healthcare/eis-live/image/authenticated/t_s200/f_auto/v1/EBSCOHealth/CCMS/i508496.png?cld_token__=exp=1589557523~hmac=39e61c4969ae0fc2034b65fa3096d7582ead7a487cd5ff89301e2f873cb2d5f1"
}
]Video Link Section when posterSize is Requested
"links": [
{
"rel": "external",
"href": "http://media.ebsco.healthcare/eis-live/video/authenticated/v1/EBSCOHealth/CCMS/Dynamed/videos/V123456.mp4"
},
{
"rel": "external",
"posterSize": "large",
"type": "poster",
"href": "http://media.ebsco.healthcare/eis-live/video/authenticated/t_s1000/f_jpg/v1/EBSCOHealth/CCMS/Dynamed/videos/V123456.jpg"
}
]Note that the video and the poster are both included. To easily distinguish, the type is set to poster.
Error Response Codes
The NAH Reference Center GET an article by article ID endpoint can return one of the error response codes.
Updated 5 days ago