Participants

Supported Formats

json
>>>

GET /api/project2s/:project_id/participants
Lists project participants

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
>>>

POST /api/project2s/:project_id/participants
Creates project participant

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
422 Unprocessable Participant.

Examples

POST /api/projects/59c241dba83dc1219d4f29f1/participants
{
  "roles": [
    "writer"
  ],
  "user_id": "59c241daa83dc1219d4f29ee",
  "participant": {
    "roles": [
      "writer"
    ],
    "user_id": "59c241daa83dc1219d4f29ee"
  }
}
201

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
participant
required

Participant parameter container

Validations:

  • Must be a Hash
participant[user_id]
required

User ID

Validations:

  • Must be a String
participant[roles]
optional

Roles of user

Validations:

  • Must be an array of any type
>>>

PUT /api/project2s/:project_id/participants/:id
Updates project participant

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Participant / Project Not Found.
422 Unprocessable Participant.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Participant ID

Validations:

  • Must be a String
participant
required

Participant parameter container

Validations:

  • Must be a Hash
participant[roles]
optional

Roles of user

Validations:

  • Must be an array of any type
>>>

DELETE /api/project2s/:project_id/participants/:id
Deletes project participant

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 Participant Not Found.
422 Unprocessable Participant.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Participant ID

Validations:

  • Must be a String
>>>

PATCH /api/project2s/:project_id/participants/:id/pause
Pauses project participant.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 Participant Not Found.
422 Unprocessable Participant.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String
id
required

Participant ID

Validations:

  • Must be a String