Protocol group membership invitation API endpoint

Table of contents

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

Endpoints

• Private portal: https://www.brainstem.org/api/private/personal_attributes/protocolgroupmembershipinvitation/ (needs a token; one record: append <id>/)
• Public portal: not available
• Response keys: protocolgroupmembershipinvitation (detail, create, update), protocolgroupmembershipinvitations (list)
• Permissions: see the permissions page

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.

Field	Description
id	UUID string [read-only]
invitee	group id [required]
protocol	protocol id [required]
can_change	boolean
manage_protocol	boolean
own_protocol	boolean

List

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

Use example (Python API tool)

resp = client.load('protocolgroupmembershipinvitation', load_all=True)
records = resp['protocolgroupmembershipinvitations']

Use example (MATLAB API tool)

resp = client.load('protocolgroupmembershipinvitation', 'load_all', true);
records = resp.protocolgroupmembershipinvitations;

Response example

{
    "protocolgroupmembershipinvitations": [
        {
            "id": "<id>",
            "invitee": "<group-id>",
            "protocol": "<protocol-id>",
            "can_change": true,
            "manage_protocol": true,
            "own_protocol": true
        }
    ],
    "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/personal_attributes/protocolgroupmembershipinvitation/
• 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('protocolgroupmembershipinvitation', data={"invitee": "<group-id>", "protocol": "<protocol-id>"})
record = resp.json()['protocolgroupmembershipinvitation']

Use example (MATLAB API tool)

created = client.save(struct('invitee', '<group-id>', 'protocol', '<protocol-id>'), 'protocolgroupmembershipinvitation');
record = created.protocolgroupmembershipinvitation;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "protocolgroupmembershipinvitation": {
        "id": "<id>",
        "invitee": "<group-id>",
        "protocol": "<protocol-id>",
        "can_change": true,
        "manage_protocol": true,
        "own_protocol": true
    }
}

Change

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/personal_attributes/protocolgroupmembershipinvitation/<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('protocolgroupmembershipinvitation', id='<id>', data={"can_change": True})

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'can_change', true), 'protocolgroupmembershipinvitation', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Custom actions

Action	Request
accept_invitation	POST /api/private/personal_attributes/protocolgroupmembershipinvitation/<id>/accept/
cancel_invitation	POST /api/private/personal_attributes/protocolgroupmembershipinvitation/<id>/cancel/
reject_invitation	POST /api/private/personal_attributes/protocolgroupmembershipinvitation/<id>/reject/