Endpoints

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:

  • 400 (bad request): If there is a problem with syntax of the request.
  • 401 (unauthorized): If authentication is missing or incorrect.
  • 403 (forbidden): If the user is not authorized to access the information, if the connection is not secure, or if the user is denied access for other reasons than authentication. 
  • 404 (not found): If no information with the given ID exists.
  • 500 (internal server error): In case of an unexpected problem on the server.

These endpoint are currently deployed to the test environment only. When they go live, test-archie.cochrane.org should be replaced by archie.cochrane.org.

Group Types

GET https://test-archie.cochrane.org/rest/groupTypes
(does not require authentication)

Returns a list of all group types in Archie.

MIME type: application/json

Example:

Response
{
  "numberOfEntries": "18",
  "groupTypes": [
    {
      "groupTypeId": "2",
      "name": "Centre",
      "link": "https://test-archie.cochrane.org/rest/groupTypes/2"
    },
    {
      "groupTypeId": "9",
      "name": "Centre Branch",
      "link": "https://test-archie.cochrane.org/rest/groupTypes/9"
    },
    ... continued ...
    {
      "groupTypeId": "3",
      "name": "Methods Group",
      "link": "https://test-archie.cochrane.org/rest/groupTypes/3"
    },
    {
      "groupTypeId": "A2D50EBA82E26AA200B088F836A8AA03",
      "name": "Methods Subgroup",
      "link": "https://test-archie.cochrane.org/rest/groupTypes/A2D50EBA82E26AA200B088F836A8AA03"
    },
    {
      "groupTypeId": "11",
      "name": "Other",
      "link": "https://test-archie.cochrane.org/rest/groupTypes/11"
    },
    ... continued ...
  ]
}

Group Type

GET https://test-archie.cochrane.org/rest/groupTypes/{groupTypeId}
(does not require authorization)

Returns information about a specific group type.

MIME type: application/json

Example:

GET https://test-archie.cochrane.org/rest/groupTypes/3

Response
{
  "groupTypeId": "3",
  "name": "Methods Group",
  "link": "https://test-archie.cochrane.org/rest/groupTypes/3",
  "reviewsAllowed": false,
  "topicsListAllowed": true,
  "countriesOfReferenceAllowed": false,
  "subgroupsAllowed": true,
  "parentGroupAllowed": true,
  "groups": [
    {
      "groupId": "4AC54DF382E26AA20120F0BE76F91BFA",
      "name": "Adverse Effects Methods Group",
      "link": "https://test-archie.cochrane.org/rest/groups/4AC54DF382E26AA20120F0BE76F91BFA"
    },
    {
      "groupId": "98",
      "name": "Bias Methods Group",
      "link": "https://test-archie.cochrane.org/rest/groups/98"
    },
    ... continued ...
  ]
}

Groups

GET https://test-archie.cochrane.org/rest/groups
(does not require authentication)

Returns a list of all groups in Archie.

MIME type: application/json

Example:

Response
{
  "numberOfEntries": "226",
  "groups": [
    {
      "groupId": "61631184746686309874111013095001",
      "name": "20th Anniversary Taskforce",
      "link": "https://test-archie.cochrane.org/rest/groups/61631184746686309874111013095001",
      "groupType": {
        "groupTypeId": "11",
        "name": "Other",
        "link": "https://test-archie.cochrane.org/rest/groupTypes/11"
      }
    },
    {
      "groupId": "48",
      "name": "Acute Respiratory Infections Group",
      "link": "https://test-archie.cochrane.org/rest/groups/48",
      "groupType": {
        "groupTypeId": "1",
        "name": "Review Group",
        "link": "https://test-archie.cochrane.org/rest/groupTypes/1"
      }
    },
    ... continued ...
  ]
}

Group

GET https://test-archie.cochrane.org/rest/groups/{groupId}
(requires authentication)

Returns information about a specific group:

MIME type: application/json

Example:

GET https://test-archie.cochrane.org/rest/groups/49
Authorization: Bearer {OAuth access token}

Response
{
  "groupId": "49",
  "name": "Airways Group",
  "link": "https://test-archie.cochrane.org/rest/groups/49",
  "groupType": {
    "groupTypeId": "1",
    "name": "Review Group",
    "link": "https://test-archie.cochrane.org/rest/groupTypes/1"
  },
  "status": "Registered",
  "registrationDate": "1995-07-04",
  "publisherId": "AIRWAYS",
  "email": "ejackson@sgul.ac.uk",
  "website": "www.airways.cochrane.org",
  "contactPerson": {
    "personId": "74957601510933433263110426105633",
    "name": "Emma Jackson",
    "link": "https://test-archie.cochrane.org/rest/people/74957601510933433263110426105633"
  },
  "address": {
    "position": "",
    "department": "Population Health Research Institute",
    "organisation": "St George's, University of London",
    "address1": "Cranmer Terrace",
    "address2": "",
    "city": "London",
    "zip": "SW17 0RE",
    "region": "",
    "country": {
      "code": "GB",
      "name": "UK"
    },
    "primaryPhone": "+44 20 8725 4327",
    "secondaryPhone": "",
    "primaryFax": "",
    "secondaryFax": ""
  },
  "subgroups": [
    {
      "groupId": "z1212201045091546329950689927376",
      "name": "Australian Satellite of the Cochrane Airways Group",
      "link": "https://test-archie.cochrane.org/rest/groups/z1212201045091546329950689927376"
    }
  ]
}
  • No labels