Skip to main content

POST User to Another Project

Overview


The following table contains important information about the POST method in regards to adding an user to another project.

POST User to Another Project
MethodPOST
URL or Endpoint/api/projects/projectId/users/connect-with-project
HeadersAuthorization
ParametersprojectId
BodyuserId, projectId, roleId, organization

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"userId": "string",
"projectId": "string",
"roleId": 4,
"organizationId": "string"
}

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

Field NameTypeDescription
userIdstringThe id of the user.
projectIdinteger($int32)The id of the project.
roleIdstringThe id of the role.
orgaizationIdstringThe id of the organization.

Response

{
"success": true,
"errors": [],
"messages": ["User added to another project successfully"],
"result": {
"userId": 6,
"projectId": 5,
"roleId": 4,
"organizationId": 3
},
"resultInfo": null,
"statusCode": 200
}

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
userIdinteger($int32)The id of the user.
projectIdinteger($int32)The id of the project.
roleIdinteger($int32)The id of the role.
organizationIdinteger($int32)The id of the organization.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

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

Errors

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

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed