Page History

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).

A more granular API, where review sections can be accessed individually, is being designed to interface with the new review database. The new API is expected to replace this API at some pointThe Review Database API provides more granular access to review content and data.

Endpoints

...

GET https://archie.cochrane.org/rest/reviews/047199081020060395/7.0

Getting review translations

List translations of the latest published version using Review ID

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 a translation of the latest published version using Review ID

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).

Getting lists of reviews / searching

...

• groupId (e.g. ARI for Acute Respiratory, see Review Group IDs below): Restrict search to reviews belonging to the specified review group. Default is any group.
• stage (R = full Review, P = Protocol, T = Title): Restrict search by review stage. Default is any stage. T is only relevant in combination with published=false.
• status (A = Active, W = Withdrawn): Restrict search by status. Default is any status.
• phase (A=Authoring, E=Editorial): Restrict search by phase. Default is any phase.
• myRole (e.g. myRole=Author): Restrict search to reviews for which the authenticated user has the given role. Default is that roles are not considered.
• myPermission (e.g myPermission=write_authoring, see Permission below): Restrict search to reviews for which the authenticated user has the given permission. Default is View permission (view).
• startSearchDate (format {yyyy-MM-dd}, e.g. startSearchDate=2014-05-31): Restrict search to reviews with a search date on or after the specified date. Default is any date.
• published (true or false). Default is true, which means that only published reviews are returned. If published=false, titles and unpublished protocols are also returned.
• issueId (e.g. 2014-1). Limit search to reviews appearing in a specific issue of The Cochrane Library (needs testing).
• translation (language code, e.g. fr). Find reviews where the latest published version has a published translation in the given language. Not compatible with published=false.

Additional endpoints

Get metadata about review

...