Laboratory API endpoint

Table of contents

  1. Endpoints
  2. Fields
  3. List
  4. Add
  5. Detail
  6. Change
  7. Delete

Endpoints

  • Private portal: https://www.brainstem.org/api/private/users/laboratory/ (needs a token; one record: append <id>/)
  • Public portal: https://www.brainstem.org/api/public/users/laboratory/ (read-only, public projects, no token)
  • Response keys: laboratory (detail, create, update), laboratories (list)
  • Permissions: see the permissions page
  • Uniqueness: group unique across BrainSTEM

Fields

[required] fields must be sent on create; [read-only] fields are returned but cannot be set. A nestable relation can be traversed in filters (filter{field.other}) and sideloaded with include[]=field.*; other relations can only be compared with ids (filter{field}=<id>). See the query syntax.

FieldDescription
idUUID string [read-only]
groupgroup id [required]; nullable
principal_investigatorslist of user ids [required]
descriptionstring; max 500 characters
websitestring; max 200 characters
departmentstring; max 100 characters
institutionstring [required]; max 100 characters
citystring; max 100 characters
countrystring; max 100 characters

List

  • Allowed portals: private, public
  • Request method: GET
  • URL: https://www.brainstem.org/api/private/users/laboratory/
  • Responses: 200 OK; 401 Not authenticated; 403 Not allowed

Use example (Python API tool)

resp = client.load('laboratory', load_all=True)
records = resp['laboratories']

Use example (MATLAB API tool)

resp = client.load('laboratory', 'load_all', true);
records = resp.laboratories;

Response example

{
    "laboratories": [
        {
            "id": "<id>",
            "group": "<group-id>",
            "principal_investigators": [
                "<user-id>"
            ],
            "description": "",
            "website": "",
            "department": "",
            "institution": "",
            "city": "",
            "country": ""
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 100,
        "total_results": 1,
        "total_pages": 1
    }
}

Add

  • Allowed portals: private
  • Request method: POST
  • URL: https://www.brainstem.org/api/private/users/laboratory/
  • Data: JSON object with at least the required fields
  • Responses: 201 Created; 400 Bad request (validation errors per field); 403 Not allowed

Use example (Python API tool)

resp = client.save('laboratory', data={"group": "<group-id>", "principal_investigators": ["<user-id>"], "institution": "<institution>"})
record = resp.json()['laboratory']

Use example (MATLAB API tool)

created = client.save(struct('group', '<group-id>', 'principal_investigators', {{'<user-id>'}}, 'institution', '<institution>'), 'laboratory');
record = created.laboratory;

Detail

  • Allowed portals: private, public
  • Request method: GET
  • URL: https://www.brainstem.org/api/private/users/laboratory/<id>/
  • Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.load('laboratory', id='<id>')
record = resp.json()['laboratory']

Use example (MATLAB API tool)

out = client.load('laboratory', 'id', '<id>');
record = out.laboratory;

Response example

{
    "laboratory": {
        "id": "<id>",
        "group": "<group-id>",
        "principal_investigators": [
            "<user-id>"
        ],
        "description": "",
        "website": "",
        "department": "",
        "institution": "",
        "city": "",
        "country": ""
    }
}

Change

  • Allowed portals: private
  • Request method: PATCH
  • URL: https://www.brainstem.org/api/private/users/laboratory/<id>/
  • Data: JSON object with the fields to change. Lists (projects, tags, …) and JSON payloads (details, coordinates) are replaced as a whole: read the record first and send the full list or object.
  • Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.save('laboratory', id='<id>', data={"description": "new value"})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'description', 'new value'), 'laboratory', 'method', 'patch');

Delete

  • Allowed portals: private
  • Request method: DELETE
  • URL: https://www.brainstem.org/api/private/users/laboratory/<id>/
  • Responses: 204 Deleted; 400 Still referenced by other records; 403 Not allowed; 404 Not found

Use example (Python API tool)

resp = client.delete('laboratory', id='<id>')

Use example (MATLAB API tool)

client.delete('<id>', 'laboratory');