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 | |
---|---|
Method | POST |
URL or Endpoint | /api/projects/projectId /users/connect-with-project |
Headers | Authorization |
Parameters | projectId |
Body | userId, projectId, roleId, organization |
The description of the URL parameter is as follows:
projectId URL Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique 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 Name | Type | Description |
---|---|---|
userId | string | The id of the user. |
projectId | integer($int32) | The id of the project. |
roleId | string | The id of the role. |
orgaizationId | string | The 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 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. |
userId | integer($int32) | The id of the user. |
projectId | integer($int32) | The id of the project. |
roleId | integer($int32) | The id of the role. |
organizationId | integer($int32) | The id of the organization. |
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.
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