Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

RETIREMENT NOTICE. This API will be retired along with Archie. Please find alternatives.

Endpoints

All endpoints require a secure connection (HTTPS). If a plain HTTP connection is attempted an error status code 403 (forbidden) is returned.

...

MIME type: application/json

 


To get information about the authenticated user this variant can be used instead:

...

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

 

Code Block
titleResponse
{
  "personId": "11143",
  "link": "https://test-archie.cochrane.org/rest/people/11143",
  "user": {
    "userId": "08573771072139469457090803092242",
    "userName": "testuser",
    "link": "https://test-archie.cochrane.org/rest/users/08573771072139469457090803092242"
  },
  "active": true,
  "prefix": "",
  "firstName": "Test",
  "middleNames": "",
  "lastName": "User",
  "suffix": "User",
  "primaryEmail": "rmoustgaard@cochrane.org",
  "secondaryEmail": "",
  "mobilePhone": "",
  "skypeName": "",
  "website": "",
  "addresses": [
    {
      "contactAddress": true,
      "homeAddress": false,
      "confidential": false,
      "position": "Fictional test personage",
      "department": "",
      "organisation": "",
      "address1": "No change in this Address",
      "address2": "",
      "city": "Copenhagen",
      "zip": "",
      "region": "",
      "country": {
        "code": "DK",
        "name": "Denmark"
      },
      "primaryPhone": "",
      "secondaryPhone": "",
      "primaryFax": "",
      "secondaryFax": ""
    },
    {
      "contactAddress": false,
      "homeAddress": true,
      "confidential": false,
      "position": "",
      "department": "",
      "organisation": "",
      "address1": "Fictional home adress",
      "address2": "",
      "city": "",
      "zip": "",
      "region": "",
      "country": {
        "code": "DK",
        "name": "Denmark"
      },
      "primaryPhone": "",
      "secondaryPhone": "",
      "primaryFax": "",
      "secondaryFax": ""
    }
  ],
  "primaryGroup": {
    "groupId": "D37BDF5182E26AA2013C72096D0CE6B1",
    "name": "Informatics & Knowledge Management",
    "link": "https://test-archie.cochrane.org/rest/groups/D37BDF5182E26AA2013C72096D0CE6B1"
  },
  "groupRoles": [
    {
      "name": "Other",
      "active": true,
      "group": {
        "groupId": "D37BDF5182E26AA2013C72096D0CE6B1",
        "name": "Informatics & Knowledge Management",
        "link": "https://test-archie.cochrane.org/rest/groups/D37BDF5182E26AA2013C72096D0CE6B1"
      }
    }
  ],
  "documentRoles": [
    {
      "name": "Contact Person",
      "document": {
        "documentPK": "z1303121044130580060054900477264",
        "title": "Better Health for Citizen",
        "link": "https://test-archie.cochrane.org/rest/reviews/739713031210441336/metadata"
      },
      "group": {
        "groupId": "64816320785104718949090902132501",
        "name": "Test CRG",
        "link": "https://test-archie.cochrane.org/rest/groups/64816320785104718949090902132501"
      }
    }
  ]
}

...

MIME type: application/json 


To get information about the authenticated user this variant can be used instead:

GET https://test-archie.cochrane.org/rest/users/me 


Example:

GET https://test-archie.cochrane.org/rest/users/08573771072139469457090803092242

...