This page describes the basic REST API for working with reviews stored in Archie. This API is interfacing with Archie's XML review document store and is therefore also XML based and works on whole reviews (in RM5 format or JATS).
The ReviewDB API provides more granular access to review content and data.
All endpoints require a secure connection (HTTPS). If a plain HTTP connection is attempted an error status code 403 (forbidden) is returned.
Authentication must be provided as either HTTP Basic authentication or as Bearer authentication using an OAuth 2.0 access token. If authentication is missing an error status code 401 (unauthorized) is returned.
Possible error codes are:
For the test version of each endpoint, replace archie.cochrane.org with test-archie.cochrane.org.
You can specify an Accept header to control the returned encoding, e.g:
Accept header | Description |
---|---|
application/xml;charset=iso-8859-1 | Review in rm5 format, iso-8859-1 charset |
application/xml;charset=utf-8 | Review in rm5 format, utf-8 charset |
application/x-jats+xml;charset=utf-8 | Review in JATS format, utf-8 charset |
application/x-dar+zip | Download JATS package |
If you don't specify an Accept header the behaviour of this API is undefined (i.e. you may get any of the above content types or encodings).
Returned MIME type is dependent on the specified Accept header. The response body contains the review in the specified format.
GET https://archie.cochrane.org/rest/reviews/{CD Number}
Example:
GET https://archie.cochrane.org/rest/reviews/CD000004
GET https://archie.cochrane.org/rest/reviews/{Review ID}
Example:
GET https://archie.cochrane.org/rest/reviews/047199081020060395
GET https://archie.cochrane.org/rest/reviews/{Review ID}/latest
Example:
GET https://archie.cochrane.org/rest/reviews/047199081020060395/latest
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}
Example:
GET https://archie.cochrane.org/rest/reviews/047199081020060395/7.0
GET https://archie.cochrane.org/rest/reviews/{Review ID}/translations
Example:
GET https://archie.cochrane.org/rest/reviews/047199081020060395/translations
The response is a list of published translations of the latest published version of the review as a JSON array:
[ { "language": "fr", "title": "Décompression abdominale en cas de suspicion d'une souffrance fœtale/pré-éclampsie", "version": "0.0", "href": "https://archie.cochrane.org/rest/reviews/047199081020060395/translations/fr" }, { "language": "hr", "title": "Abdominalna dekompresija kod sumnje na ugrožen fetus ili pre-eklampsiju", "version": "5.0", "href": "https://archie.cochrane.org/rest/reviews/047199081020060395/translations/hr" }, { "language": "ta", "title": "கருத்தடை சமரசம் / முன்-எக்லம்ப்சியா என சந்தேகிக்கப்படும் அடிவயிற்று சுருக்க சிகிச்சை.", "version": "1.0", "href": "https://archie.cochrane.org/rest/reviews/047199081020060395/translations/ta" } ] |
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/translations
The response is as described for the previous endpoint.
GET https://archie.cochrane.org/rest/reviews/{Review ID}/translations/{language}
Example:
GET https://archie.cochrane.org/rest/reviews/047199081020060395/translations/fr
Returns the translation as either JATS XML or the full JATS package (as determined by the Accept header - see "Encoding of response" above).
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/translations/{language}
The response is as described for the previous endpoint.
The base request for getting a list of reviews is:
GET https://archie.cochrane.org/rest/reviews
This will return all published reviews in Archie, so for most purposes a filter based on query parameters is required.
The response is an XML document listing the key attributes and properties of each review, and a link for accessing the full review, e.g.:
<reviews count="15"> <review cdNumber="CD002745" groupId="ARI" reviewId="780800041114324239" searchDate="2011-06-27" stage="R" status="A" checkedOut="false"> <link href="https://test-archie.cochrane.org/rest/reviews/CD002745" rel="self" type="application/xml"/> <title>Amantadine and rimantadine for influenza A in children and the elderly</title> <byline>Alves Galvão MG, Rocha Crispino Santos MA, Alves da Cunha AJL</byline> <group>Acute Respiratory Infections Group</group> </review> <review cdNumber="CD000243" groupId="ARI" reviewId="482299081614134252" searchDate="2013-03-20" stage="R" status="A"checkedOut="true"> <link href="https://test-archie.cochrane.org/rest/reviews/CD000243" rel="self" type="application/xml"/> <title>Antibiotics for acute maxillary sinusitis in adults</title> <byline>Ahovuo-Saloranta A, Rautakorpi U-M, Borisenko OV, Liira H, Williams Jr JW, Mäkelä M</byline> <group>Acute Respiratory Infections Group</group> </review> ... </reviews> |
The following query parameters can be used to restrict the search:
GET https://archie.cochrane.org/rest/reviews/{Review ID}/metadata
Returned MIME type is "application/json".
GET https://archie.cochrane.org/rest/reviews/{Review ID}/versions
Returned MIME type is "application/json".
GET https://archie.cochrane.org/rest/reviews/{Review ID}/roles
Returned MIME type is "application/json".
The following return assets referenced from the main JATS XML.
Endpoint | MIME type |
---|---|
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/{Asset path}.svg | "image/svg+xml" |
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/{Asset path}.png | "image/png" |
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/{Asset path}.jpg | "image/jpeg" |
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/{Asset path}.(xml | rm5) | "application/xml;charset=utf-8", "application/xml;charset=UTF-8" |
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/{Asset path}.html | "text/html" |
GET https://archie.cochrane.org/rest/reviews/{Review ID}/{Version}/{Asset path}.zip | "application/zip" |
For use with the groupId parameter.
Group Name | ID |
---|---|
Acute Respiratory Infections Group | ARI |
Airways Group | AIRWAYS |
Anaesthesia Group | ANAESTH |
Back Group | BACK |
Bone, Joint and Muscle Trauma Group | MUSKINJ |
Breast Cancer Group | BREASTCA |
Childhood Cancer Group | CHILDCA |
Colorectal Cancer Group | COLOCA |
Consumers and Communication Group | COMMUN |
Cystic Fibrosis and Genetic Disorders Group | CF |
Dementia and Cognitive Improvement Group | DEMENTIA |
Depression, Anxiety and Neurosis Group | DEPRESSN |
Developmental, Psychosocial and Learning Problems Group | BEHAV |
Drugs and Alcohol Group | ADDICTN |
Ear, Nose and Throat Disorders Group | ENT |
Effective Practice and Organisation of Care Group | EPOC |
Epilepsy Group | EPILEPSY |
Eyes and Vision Group | EYES |
Fertility Regulation Group | FERTILREG |
Gynaecological Cancer Group | GYNAECA |
Haematological Malignancies Group | HAEMATOL |
Heart Group | VASC |
Hepato-Biliary Group | LIVER |
HIV/AIDS Group | HIV |
Hypertension Group | HTN |
Incontinence Group | INCONT |
Infectious Diseases Group | INFECTN |
Inflammatory Bowel Disease and Functional Bowel Disorders Group | IBD |
Injuries Group | INJ |
Lung Cancer Group | LUNGCA |
Menstrual Disorders and Subfertility Group | MENSTR |
Metabolic and Endocrine Disorders Group | ENDOC |
Methodology Review Group | METHOD |
Movement Disorders Group | MOVEMENT |
Multiple Sclerosis and Rare Diseases of the Central Nervous System Group | MS |
Musculoskeletal Group | MUSKEL |
Neonatal Group | NEONATAL |
Neuromuscular Disease Group | NEUROMUSC |
Occupational Safety and Health Group | OCCHEALTH |
Oral Health Group | ORAL |
Pain, Palliative and Supportive Care Group | SYMPT |
Peripheral Vascular Diseases Group | PVD |
Pregnancy and Childbirth Group | PREG |
Prostatic Diseases and Urologic Cancers Group | PROSTATE |
Public Health Group | PUBHLTH |
Renal Group | RENAL |
Schizophrenia Group | SCHIZ |
Sexually Transmitted Infections Group | STI |
Skin Group | SKIN |
Stroke Group | STROKE |
Tobacco Addiction Group | TOBACCO |
Upper Gastrointestinal and Pancreatic Diseases Group | UPPERGI |
Wounds Group | WOUNDS |
For use with the myPermission parameter.
Permission Name | Parameter Value |
---|---|
Delete Document | delete |