POST Users with Roles to Project

Overview

The following table contains important information about the POST method in regards to adding a user with a role to a project.

POST Users with Roles to Project
Method	POST
URL or Endpoint	/api/projects/`projectId`/users/add-users-to-project
Headers	Authorization
Parameters	projectId
Body	projectId, userRoles, userId, roleId

The description of the URL parameter is as follows:

Request Body

{
  "projectId": "string",
  "userRoles": [
    {
      "userId": "string",
      "roleId": 57
    }
  ]
}

Information about the fields that appear in the request body are displayed in the table below.

Field Name	Type	Description
projectId	string	The id of the project.
userRoles	array[Object]	Returns the user roles as an array of objects.
userId	string	The id of the user.
roleId	integer($int32)	The id of the role.

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": true,
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: