Regulatory authority API endpoint

Table of contents

1. Fields
2. List view
3. Add
4. Detail
5. Change
6. Delete
7. List approvals
8. Detail approval
9. Accept approval
10. Reject approval

Fields

Field	Description
id	UUID identificator formatted as a string
name	string [required] [max length: 255; must be unique]
abbreviation	string [max length: 32]
country	ISO 3166-1 alpha-2 country code string
authority_type	string [max length: 64]. Choices: national, institutional, regional, international
website	URL string [max length: 200]
description	string
is_active	boolean [default: True]; indicates whether the authority is currently operational

Optional fields such as abbreviation and comments can be omitted from list/detail responses when empty.

List view

• Allowed portals: public, private
• Request method: GET
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthority
• Data: None
• Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load_model('regulatoryauthority')

Response example

{'regulatoryauthorities': [
    {
        'id': 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
        'name': 'Institutional Animal Care and Use Committee',
        'abbreviation': 'IACUC',
        'country': 'US',
        'authority_type': 'institutional',
        'website': 'https://www.example.edu/iacuc',
        'description': 'Institutional committee overseeing animal research compliance.',
        'is_active': True
    },
    {
        'id': 'b2c3d4e5-f6a7-8901-bcde-f12345678901',
        'name': 'Home Office',
        'abbreviation': 'HO',
        'country': 'GB',
        'authority_type': 'national',
        'website': 'https://www.gov.uk/government/organisations/home-office',
        'description': 'UK national authority issuing project and personal licences for animal research.',
        'is_active': True
    }
]}

Public list responses also include a meta object (pagination/filter metadata).

Add

• Allowed portals: private
• Request method: POST
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthority
• Data: JSON dictionary containing at least the required fields.
• Responses: 201 OK; 400 Bad request; 403 Not allowed; 404 Not found

Note: Regulatory authority submissions go through an approval process.

Use example (using Python API)

resp = client.save_model("regulatoryauthority", data={
    "name": "Animal Ethics Committee",
    "abbreviation": "AEC",
    "country": "AU",
    "authority_type": "institutional",
    "description": "Institutional committee approving animal research protocols."
})

Response example

{'regulatoryauthority_approval': {
    'id': 'c3d4e5f6-a7b8-9012-cdef-123456789012',
    'name': 'Animal Ethics Committee',
    'abbreviation': 'AEC',
    'country': 'AU',
    'authority_type': 'institutional',
    'website': '',
    'description': 'Institutional committee approving animal research protocols.',
    'is_active': True,
    'instance_id': None,
    'action': 'Add',
    'reviewer': None,
    'status': 'Pending'}
}

Detail

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

Use example (using Python API)

resp = client.load_model('regulatoryauthority', id='a1b2c3d4-e5f6-7890-abcd-ef1234567890')

Response example

{'regulatoryauthority': {
    'id': 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'name': 'Institutional Animal Care and Use Committee',
    'abbreviation': 'IACUC',
    'country': 'US',
    'authority_type': 'institutional',
    'website': 'https://www.example.edu/iacuc',
    'description': '',
    'is_active': True}
}

Change

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthority/<id>/
• Data: dictionary containing the fields to be updated
• Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Note: Regulatory authority changes go through an approval process.

Use example (using Python API)

resp = client.save_model("regulatoryauthority", id="a1b2c3d4-e5f6-7890-abcd-ef1234567890", data={"description": "Updated description."})

Response example

{'regulatoryauthority_approval': {
    'id': 'd4e5f6a7-b8c9-0123-defa-234567890123',
    'name': 'Institutional Animal Care and Use Committee',
    'abbreviation': 'IACUC',
    'country': 'US',
    'authority_type': 'institutional',
    'website': '',
    'description': 'Updated description.',
    'is_active': True,
    'instance_id': 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'action': 'Change',
    'reviewer': None,
    'status': 'Pending'}
}

Delete

• Allowed portals: private
• Request method: DELETE
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthority/<id>/
• Data: None
• Responses: 204 OK; 403 Not allowed; 404 Not found

Note: Only administrators can delete regulatory authorities.

Use example (using Python API)

resp = client.delete_model("regulatoryauthority", id="a1b2c3d4-e5f6-7890-abcd-ef1234567890")

List approvals

• Allowed portals: private
• Request method: GET
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval
• Data: None
• Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load_model('regulatoryauthorityapproval')

Response example

{'regulatoryauthority_approvals': [
    {
        'id': 'c3d4e5f6-a7b8-9012-cdef-123456789012',
        'name': 'Animal Ethics Committee',
        'abbreviation': 'AEC',
        'country': 'AU',
        'authority_type': 'institutional',
        'website': '',
        'description': '',
        'is_active': True,
        'instance_id': None,
        'action': 'Add',
        'reviewer': None,
        'status': 'Pending'
    }
]}

Detail approval

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

Use example (using Python API)

resp = client.load_model('regulatoryauthorityapproval', id='c3d4e5f6-a7b8-9012-cdef-123456789012')

Response example

{'regulatoryauthority_approval': {
    'id': 'c3d4e5f6-a7b8-9012-cdef-123456789012',
    'name': 'Animal Ethics Committee',
    'abbreviation': 'AEC',
    'country': 'AU',
    'authority_type': 'institutional',
    'website': '',
    'description': '',
    'is_active': True,
    'instance_id': None,
    'action': 'Add',
    'reviewer': None,
    'status': 'Pending'}
}

Accept approval

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/<id>/accept/
• Data: None
• Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("regulatoryauthorityapproval", id="c3d4e5f6-a7b8-9012-cdef-123456789012", options="accept")

Reject approval

• Allowed portals: private
• Request method: PATCH
• URL: https://www.brainstem.org/api/private/taxonomies/regulatoryauthorityapproval/<id>/reject/
• Data: None
• Responses: 200 OK; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.save_model("regulatoryauthorityapproval", id="c3d4e5f6-a7b8-9012-cdef-123456789012", options="reject")