GET User of an Organization not in a Project
Overview
The following table contains important information about the GET
method in regards to receiving the users of an organization that are not in a certain project.
GET User of an Organization not in a Project | |
---|---|
Method | GET |
URL or Endpoint | /api/projects/projectId /users/user-organization |
Headers | Authorization |
Parameters | projectId, search, page, take, order, insertedDate |
Body | Not Applicable |
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. |
The description of the parameters is as follows:
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
search | No | string | A word you want to filter. |
page | Yes | integer($int32) | The page in which the user is located |
take | Yes | integer($int32) | The number of users to take from the page |
order | Yes | string | The order in which you receive the users. |
insertedDate | No | Date | The date |
Request Body
The request does not contain a request body.
{
"success": true,
"errors": [],
"messages": [],
"result": {
"currentPage": 1,
"totalPages": 5,
"pageSize": 2,
"totalCount": 9,
"items": [
{
"publicId": "string",
"globalId": "string",
"firstname": "string",
"lastname": "string",
"picture": null,
"email": "string",
"isActive": true,
"role": {
"id": 0,
"name": null,
"description": null,
"isActive": false,
"organizationId": null
},
"isConfirmed": 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. |
publicId | string | The id of the user |
globalId | string | The global id of the user. |
firstName | string | The first name of the user. |
lastName | string | The last name of the user. |
picture | Image | The picture of the user. |
string | The email of the user. | |
isActive | bool | Indicates whether the user is active. |
role | Object | Returns the role as an object. |
id | integer($int32) | The id of the |
name | string | The name of the role. |
description | string | The description of the role. |
isActive | bool | Indicates whether the role is active. |
organizationId | integer($int32) | The id of the organization. |
isConfirmed | bool | Indicates whether the user is confirmed. |
defaultOrganizationId | integer($int32) | The default 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