Project Membership Invitation API endpoint

Table of contents

1. Fields
2. List view
3. Detail
4. Accept
5. Reject
6. Cancel

Fields

Field	Description
id	UUID identificator formatted as a string
invitee	invited user ID formatted as an integer
project	related project ID formatted as a string
can_change	boolean
manage_project	boolean
own_project	boolean

List view

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

Use example (using Python API)

resp = client.load('projectmembershipinvitation')

Response example

{'project_membership_invitations': [
    {
        'id': '<id>',
        'invitee': 27,
        'project': '<project-id>',
        'can_change': False,
        'manage_project': False,
        'own_project': False
    },
    {
        'id': '<id>',
        'invitee': 1,
        'project': '<project-id>',

        'can_change': False,
        'manage_project': False,
        'own_project': False
    }
]}

Detail

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

Use example (using Python API)

resp = client.load('projectmembershipinvitation', id='<id>')

Response example

{'project_membership_invitation': {
    'id': '<id>',
    'invitee': 27,
    'project': '<project-id>',
    'can_change': False,
    'manage_project': False,
    'own_project': False}
}

Accept

• Allowed portals: private
• Request method: GET
• URL: https://www.brainstem.org/api/private/stem/projectmembershipinvitation/<id>/accept/
• Data: None
• Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load("projectmembershipinvitation", id="<id>", options="accept")

Reject

• Allowed portals: private
• Request method: GET
• URL: https://www.brainstem.org/api/private/stem/projectmembershipinvitation/<id>/reject/
• Data: None
• Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load("projectmembershipinvitation", id="<id>", options="reject")

Cancel

• Allowed portals: private
• Request method: GET
• URL: https://www.brainstem.org/api/private/stem/projectmembershipinvitation/<id>/cancel/
• Data: None
• Responses: 200 OK; 400 Bad request; 403 Not allowed; 404 Not found

Use example (using Python API)

resp = client.load("projectmembershipinvitation", id="<id>", options="cancel")