Episode personnel 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/modules/episodepersonnel/ (needs a token; one record: append <id>/)
• Public portal: https://www.brainstem.org/api/public/modules/episodepersonnel/ (read-only, public projects, no token)
• Response keys: episode_personnel (detail, create, update), episode_personnels (list)
• Permissions: see the permissions page
• Uniqueness: episode, person, role unique together

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	number [read-only]
episode	procedureepisode id [required]
person	user id [required]
role	one of surgeon, anesthetist, assistant, observer, veterinarian, responsible_person [required]

List

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

Use example (Python API tool)

resp = client.load('episodepersonnel', load_all=True)
records = resp['episode_personnels']

Use example (MATLAB API tool)

resp = client.load('episodepersonnel', 'load_all', true);
records = resp.episode_personnels;

Response example

{
    "episode_personnels": [
        {
            "id": 1,
            "episode": "<procedureepisode-id>",
            "person": "<user-id>",
            "role": "surgeon"
        }
    ],
    "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/modules/episodepersonnel/
• 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('episodepersonnel', data={"episode": "<procedureepisode-id>", "person": "<user-id>", "role": "surgeon"})
record = resp.json()['episode_personnel']

Use example (MATLAB API tool)

created = client.save(struct('episode', '<procedureepisode-id>', 'person', '<user-id>', 'role', 'surgeon'), 'episodepersonnel');
record = created.episode_personnel;

Detail

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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

Response example

{
    "episode_personnel": {
        "id": 1,
        "episode": "<procedureepisode-id>",
        "person": "<user-id>",
        "role": "surgeon"
    }
}

Change

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

Use example (MATLAB API tool)

client.save(struct('id', '<id>', 'episode', '<procedureepisode-id>'), 'episodepersonnel', 'method', 'patch');

Delete

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

Use example (Python API tool)

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

Use example (MATLAB API tool)

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