{"info":{"title":"/IOTCONNECT™ User API","description":"User REST API contains information of User, Role and Entity modules.\n

Headers

Needed Headers for all the API. \n
\n
Authorization     Bearer + access_token (Generated From api/v1.1/auth/login API)\n
Content-Type    application/json

","version":"2.1"},"paths":{"/api/v2.1/Entity":{"post":{"tags":["Entity"],"summary":"Add new entity","description":"

An entity in IoTConnect is the company/location-based hierarchy where users can manage different entities/companies under which several devices and users can be managed. The entity facilitates a user to control multiple sub-companies under a parent company. When you create a company, an entity gets created automatically, which is considered as a parent entity of your company.

\n

This API endpoint allows you to add new entities for your company. Such new entities get their place under a parent entity. Here name, parentEntityGuid, address, city, countryGuid, stateGuid are mandatory. If you opt to create an entity owner, firstName, lastName, userId, roleGuid, timeZoneGuid are mandatory.

","responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that entity is created successfully and returns created entity guid.","schema":{"$ref":"#/definitions/EntityCreateResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EntityCreateV2Request"}}]},"get":{"tags":["Entity"],"summary":"Get entity list","description":"

Get a list of available entities of your company using this API endpoint.

","responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that entity list is loaded successfully.","schema":{"$ref":"#/definitions/EntityListResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Entity/{entityGuid}":{"put":{"tags":["Entity"],"summary":"Update an entity","description":"

To update entity name, location details, or a parent-child architecture relationship, use this API endpoint. You need to send entityGuid in request url and updated entity details in the request body.

\n

Here, you even have an option to set an existing user as the owner of the entity. For that, you need to send a user guid in ownerUserGuid parameter. To arrange a new user as an entity owner, you need to send user details in the userInfo parameter.

","parameters":[{"name":"entityGuid","in":"path","description":"Guid of Entity which needs to be updated","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EntityUpdateRequest"}}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that entity is updated successfully.","schema":{"$ref":"#/definitions/EntityUpdateResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}},"delete":{"tags":["Entity"],"summary":"Delete an entity","description":"

This API endpoint allows you to delete an entity. For that, you need to send entityGuid in request url.

","parameters":[{"name":"entityGuid","in":"path","description":"Guid of Entity which needs to be deleted","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that entity is deleted successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}},"get":{"tags":["Entity"],"summary":"Get single entity detail","description":"

This API endpoint gives you a detailed description of any entity of your company. For that, you need to send entityGuid in request url.

","parameters":[{"name":"entityGuid","in":"path","description":"Entity Guid","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that entity details are loaded successfully.","schema":{"$ref":"#/definitions/EntityDetailResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Entity/lookup":{"get":{"tags":["Entity"],"summary":"Get entity lookup list","description":"

This API endpoint allows you to get the lookup list of available entities in your company.

","responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that entity lookup list is loaded successfully.","schema":{"$ref":"#/definitions/EntityLookupResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Entity/{entityGuid}/properties":{"put":{"tags":["Entity"],"summary":"Update custom property value","description":"

This API endpoint allows you to update custom property values. For that, you need to send entityGuid in request url along with custom property guid and updated custom property value in the request body.

","parameters":[{"name":"entityGuid","in":"path","description":"Guid of Entity which needs to be updated","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EntityPropertiesUpdateRequest"}}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that custom property is updated successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Entity/{entityGuid}/property/{propertyGuid}":{"delete":{"tags":["Entity"],"summary":"Delete custom property value","description":"

This API endpoint allows you to delete a custom property value for an entity. For that, you need to send entityGuid and customPropertyGuid in request url.

","parameters":[{"name":"entityGuid","in":"path","description":"Guid of Entity which needs to be updated","required":true,"type":"string","format":"uuid"},{"name":"propertyGuid","in":"path","description":"Guid of property which needs to be deleted from entity","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that custom property is deleted successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Entity/bulk-import/history":{"get":{"tags":["Entity"],"summary":"Get entity bulk import list","description":"

This API endpoint provides you the list of all imported entities in bulk. This will give you the current status of all batch import along with the count of entities with validation status as success and failure.

","parameters":[{"name":"pageNumber","in":"query","description":"To fetch specific page data. Eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. Eg: 25","type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"Sort by name and order. Eg. createdDate desc, createdDate asc, createdDate, entityName","type":"string"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the entity bulk import list received successfully.","schema":{"$ref":"#/definitions/EntityBulkImportListResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}}}},"/api/v2.1/Entity/bulk-import/{parentEntityGuid}/validate":{"post":{"tags":["Entity"],"summary":"Validate entities in batch","description":"

This API endpoint helps to validate entities along with users in bulk for the given parent entity guid. For that, upload a JSON file in the file parameter, containing list of entities and an optional respective user for respective entity along with children entities that you want to create under a given parent entity.

","parameters":[{"name":"parentEntityGuid","in":"path","description":"A valid entity guid of parent","required":true,"type":"string","format":"uuid"},{"name":"file","in":"formData","description":"","type":"file","required":true}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the external device process validated successfully.","schema":{"$ref":"#/definitions/EntityBulkImportValidateResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEntity doesn't exist and invalid logged user or company."}}}},"/api/v2.1/Entity/bulk-import/{bulkImportGuid}/file":{"get":{"tags":["Entity"],"summary":"Get bulk entity import file content","parameters":[{"name":"bulkImportGuid","in":"path","description":"Bulk import guid","required":true,"type":"string","format":"uuid"},{"name":"isSuccess","in":"query","description":"Nullable, if not passed. It will download user uploaded content. if true: it will download success data. if false: it will download failed entity data","type":"boolean"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"type":"string"}}}}},"/api/v2.1/Entity/bulk-import/{bulkImportGuid}":{"delete":{"tags":["Entity"],"summary":"Cancel bulk entity to import","parameters":[{"name":"bulkImportGuid","in":"path","description":"Bulk import guid","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityBulkImportCancelResponse"}},"204":{"description":"No Content","schema":{"$ref":"#/definitions/NoContentResult"}}}}},"/api/v2.1/Entity/bulk-import/{bulkImportGuid}/init":{"post":{"tags":["Entity"],"summary":"Initialize bulk entity to import","parameters":[{"name":"bulkImportGuid","in":"path","description":"Bulk import guid","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityBulkImportListResponse"}},"204":{"description":"No Content","schema":{"$ref":"#/definitions/NoContentResult"}}}}},"/api/v2.1/Role":{"post":{"tags":["Role"],"summary":"Add new role","description":"

When you create a company, the admin role gets created automatically and the company admin user associates with this role.

\n

This API endpoint allows you to create new roles for your company users. A role defines the permissions for users.

","responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role is created successfully and returns created role guid.","schema":{"$ref":"#/definitions/RoleCreateResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/RoleCreateRequest"}}]}},"/api/v2.1/Role/{roleGuid}":{"put":{"tags":["Role"],"summary":"Update a role","description":"

This API endpoint is used to update a role. For that, you need to send roleGuid in request url and updated role details in the request body.

","parameters":[{"name":"roleGuid","in":"path","description":"Guid of Role which needs to be updated","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/RoleUpdateRequest"}}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role is updated successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}},"delete":{"tags":["Role"],"summary":"Delete a role","description":"

This API endpoint allows you to delete a role. For that, you need to send roleGuid in request url. This will not allow you to remove if the role is associated with any user.

","parameters":[{"name":"roleGuid","in":"path","description":"Guid of Role which needs to be deleted","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role is deleted successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}},"get":{"tags":["Role"],"summary":"Get single role details","description":"

This API endpoint provides you a detailed description of a role. For that, you need to send roleGuid in request url.

","parameters":[{"name":"roleGuid","in":"path","description":"Role Guid","required":true,"type":"string","format":"uuid"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role details are loaded successfully.","schema":{"$ref":"#/definitions/RoleDetailResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Role/{roleGuid}/status":{"put":{"tags":["Role"],"summary":"Update role status","description":"

This API endpoint allows you to update the active status of a role. For that, you need to send roleGuid in request url. This will not allow you to change active status if the role is associated with any user.

","parameters":[{"name":"roleGuid","in":"path","description":"Guid of Role for which active status needs to be updated","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Active status. send active/inactive","schema":{"$ref":"#/definitions/RoleStatusUpdateV2Request"}}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role active status is updated successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Role/lookup":{"get":{"tags":["Role"],"summary":"Get role list","description":"

This API endpoint gives you the lookup list of available roles in your company.

","responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role lookup list is loaded successfully.","schema":{"$ref":"#/definitions/RoleListResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/Role/role-user":{"get":{"tags":["Role"],"summary":"Get role list with user count","description":"

Using this API endpoint, you can get the list of available roles in your company along with associated users count.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"pageNumber","in":"query","description":"To fetch specific page data. eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. eg: 25","type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"To sort the list. To do that, Specify Field name to sort with and sorting order. eg: name asc","type":"string"},{"name":"Name","in":"query","description":"Role Name","type":"string"},{"name":"Status","in":"query","description":"status like active,inactive or both","type":"string"},{"name":"Usercount","in":"query","type":"string"}],"responses":{"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that role list is loaded successfully.","schema":{"$ref":"#/definitions/RoleListWithUserCountResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User":{"post":{"tags":["User"],"summary":"Add new user","description":"

This API endpoint allows you to add new users to your company.

\n

Here, the properties parameter is optional. entityGuid defines that the user belongs to which entity. You can get the list of available entities for your company from Entity API. roleGuid sets the permissions for a user. You can get the list of roles from Role API.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user is created successfully and returns created user guid.","schema":{"$ref":"#/definitions/UserCreateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nDuplicate user email id, Entity doesn't exist, Role doesn't exist, Role is not active, User quota has been exceeded, Company doesn't exist, Logged in user is not valid etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/UserCreateV2Request"}}]},"get":{"tags":["User"],"summary":"Get user list","description":"

This API endpoint provides you the list of users in your company.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"pageNumber","in":"query","description":"To fetch specific page data. eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. eg: 25","type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"To sort the list. To do that, Specify Field name to sort with and sorting order. eg: firstName asc, lastName desc, roleName, entityName, userid, updatedDate, isActive","type":"string"},{"name":"FirstName","in":"query","type":"string"},{"name":"LastName","in":"query","type":"string"},{"name":"Email","in":"query","type":"string"},{"name":"ContactNo","in":"query","type":"string"},{"name":"Role","in":"query","type":"string"},{"name":"Entity","in":"query","type":"string"},{"name":"Status","in":"query","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user list is loaded successfully.","schema":{"$ref":"#/definitions/UserGetListResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/{userGuid}":{"put":{"tags":["User"],"summary":"Update user details","description":"

This API endpoint allows you to update user details like first name, last name, contact number, a role assigned, entity, or device allocation. For that, you need to send userGuid in request url and updated user details in the request body.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/UserUpdateRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user is updated successfully.","schema":{"$ref":"#/definitions/UserUpdateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist, Entity doesn't exist, Role doesn't exist, Role is not active, Company doesn't exist, Logged in user is not valid etc."}}},"delete":{"tags":["User"],"summary":"Delete user","description":"

This API endpoint allows you to delete a user. For that, you need to send userGuid in request url.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/UserDeleteRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user is deleted successfully.","schema":{"$ref":"#/definitions/UserDeleteResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist, Company doesn't exist, Logged in user is not valid etc."}}},"get":{"tags":["User"],"summary":"Get single user details","description":"

This API endpoint allows you to get a detailed description of a user. For that, you need to send userGuid in request url.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"userInfoFlag","in":"query","description":"To include or exclude user info detail from response.\ntrue: to include, false: to exclude. By default details are included.","type":"boolean"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user details are loaded successfully.","schema":{"$ref":"#/definitions/UserResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist, Company doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/{userGuid}/status":{"put":{"tags":["User"],"summary":"Update user status","description":"

This API endpoint allows you to update the active status of a user. For that, you need to send userGuid in request url.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/UserStatusChangeV2Request"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user active status is updated successfully.","schema":{"$ref":"#/definitions/SuccessResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist, Status is already updated, Company doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/lookup":{"get":{"tags":["User"],"summary":"Get user lookup list","description":"

This API endpoint gives you the lookup list of users in your company.

","parameters":[{"name":"isEntityUser","in":"query","description":"To fetch the users available in logged in user's entity (includes child entity users as well).\ntrue: to fetch only entity users, false: to fetch all users. By default it will give all users.","type":"boolean"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user lookup list is loaded successfully.","schema":{"$ref":"#/definitions/UserLookupResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/role/{roleGuid}/user":{"get":{"tags":["User"],"summary":"Get user list by role","description":"

This API endpoint provides you the list of users associated with a given role in your company. For that, you need to send roleGuid in request url.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"roleGuid","in":"path","description":"Role Guid","required":true,"type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"To fetch specific page data. eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. eg: 25","type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"To sort the list. To do that, Specify Field name to sort with and sorting order. eg: firstName asc, lastName desc, roleName, entityName, userid, isActive, updatedDate asc","type":"string"},{"name":"FirstName","in":"query","description":"User's First Name","type":"string"},{"name":"LastName","in":"query","description":"User's Last Name","type":"string"},{"name":"Email","in":"query","description":"User's Email Id","type":"string"},{"name":"ContactNo","in":"query","description":"User's Contact Number","type":"string"},{"name":"Role","in":"query","description":"User's Role","type":"string"},{"name":"Entity","in":"query","description":"User's Entity","type":"string"},{"name":"Status","in":"query","description":"User's Active Status","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user list is loaded successfully.","schema":{"$ref":"#/definitions/UserListByEntityResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/entity/{entityGuid}/user":{"get":{"tags":["User"],"summary":"Get user list by entity","description":"

This API endpoint gives you the list of users under a given entity in your company. For that, you need to send entityGuid in request url.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"entityGuid","in":"path","description":"Entity Guid","required":true,"type":"string","format":"uuid"},{"name":"roleGuid","in":"query","description":"Role Guid","type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"To fetch specific page data. eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. eg: 25","type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"To sort the list. To do that, Specify Field name to sort with and sorting order. eg: firstName asc, lastName desc, roleName, entityName, userid, updatedDate, isActive asc","type":"string"},{"name":"isActiveUser","in":"query","type":"boolean"},{"name":"FirstName","in":"query","description":"User's First Name","type":"string"},{"name":"LastName","in":"query","description":"User's Last Name","type":"string"},{"name":"Email","in":"query","description":"User's Email Id","type":"string"},{"name":"ContactNo","in":"query","description":"User's Contact Number","type":"string"},{"name":"Role","in":"query","description":"User's Role","type":"string"},{"name":"Entity","in":"query","description":"User's Entity","type":"string"},{"name":"Status","in":"query","description":"User's Active Status","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user list is loaded successfully.","schema":{"$ref":"#/definitions/UserListByEntityResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/preference":{"get":{"tags":["User"],"summary":"Get user preference details","description":"

This API endpoint gives you the user preference details for currently logged in users. User preferences show you that whether a user has opted for notifications. And if opted, what type of notifications. It also provides you page size preference and time zone detail.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user preference list is loaded successfully.","schema":{"$ref":"#/definitions/UserPreferenceListResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}},"put":{"tags":["User"],"summary":"Update user preference details","description":"

When you create a user, default preferences set automatically for that user. Nevertheless, you can update those preferences anytime later.

\n

This API endpoint allows you to update currently logged in user’s preferences details.

\n

Here, you have an option to opt for notifications like email, sms, push. In case of email notifications, you have a choice whether you want to receive notifications on the primary email address (user’s login id) or secondary email address. If you opt for a secondary email, you need to enter that email address in alternateEmailID parameter. To change the user’s time zone, you need to send timeZoneGuid in the parameter. You can also get the list of available time zones from Master API.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user preference is updated successfully.","schema":{"$ref":"#/definitions/UserPreferenceUpdateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, User is not active, Logged in user is not valid etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/PreferenceUpdateRequest"}}]}},"/api/v2.1/User/change-password":{"post":{"tags":["User"],"summary":"Change password","description":"

This API endpoint allows you to change the user’s login password. For that, you need to send the user’s login email id, old password and new password in the request body.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the user password is changed successfully.","schema":{"$ref":"#/definitions/UserChangePasswordResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nOld password doesn't match, Company doesn't exist, User is not valid etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/ChangePasswordRequest"}}]}},"/api/v2.1/User/forgot-password":{"post":{"tags":["User"],"summary":"Forgot password","description":"

When you forget your password, you need to reset. For that, you need an invitation link that takes you to reset password page to change the password.

\n

This API endpoint allows you to send an invitation link to reset your password. For that, you need to send your login email id. It sends you an invitation link on your login email id. By using that url, you will be able to reset your password.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that email has been sent successfully to reset the password.","schema":{"$ref":"#/definitions/UserForgetPasswordResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/ForgotPasswordRequest"}}]}},"/api/v2.1/User/reset-password":{"post":{"tags":["User"],"summary":"Reset password","description":"

This API endpoint allows you to reset your password. For that, you need to send your login email id, invitation guid and your new password. An invitation will be generated at the time of creating a new user and when a user asks to reset the password using the forgot password API. You need that newly generated invitation’s guid in invitationGuid parameter in the request body.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user has reset the password successfully.","schema":{"$ref":"#/definitions/UserResetPasswordResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/ResetPasswordRequest"}}]}},"/api/v2.1/User/reset-password/resend":{"post":{"tags":["User"],"summary":"Resend reset password link","description":"

This API endpoint allows you to resend the invitation link to the user’s email id to reset the password. For that, you need to send the user’s login email id in email parameter in the request body.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the user password is reset successfully and an email has been sent to user's email id.","schema":{"$ref":"#/definitions/SuccessResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist, User is not active, Company doesn't exist, Logged in user is not valid etc."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/ResendResetPasswordRequest"}}]}},"/api/v2.1/User/{userGuid}/properties":{"put":{"tags":["User"],"summary":"Update custom property value","description":"

This API endpoint allows you to update the custom property value of a user. For that, you need to send userGuid in request url along with customPropertyGuid and value in the request body.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/UserPropertiesUpdateRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that custom property is updated successfully.","schema":{"$ref":"#/definitions/UserPropertyUpdateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nProperty doesn't exist, Company doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/{userGuid}/property/{propertyGuid}":{"delete":{"tags":["User"],"summary":"Delete custom property value","description":"

This API endpoint allows you to delete a custom property value of a user. For that, you need to send userGuid and customPropertyGuid in request url.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"propertyGuid","in":"path","description":"Custom Property Guid","required":true,"type":"string","format":"uuid"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that custom property is deleted successfully.","schema":{"$ref":"#/definitions/UserPropertyDeleteResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nProperty doesn't exist, Company doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/identity":{"get":{"tags":["User"],"summary":"logged in user detail","description":"

This API endpoint provides you the currently logged in user’s details.

\n

Here, along with user details, you can also access the user’s permission details. The information can help you to know that users can access which modules with what permissions, such as a view or operate. For that, you need to send true in query string parameter permissions.

","parameters":[{"name":"permissions","in":"query","description":"true : to include logged-in user's permissions detail, false : to exclude permissions detail. By default permissions detail will be excluded.","type":"boolean"},{"name":"includeConfigSettings","in":"query","description":"Send true to get configuration settings","type":"boolean"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user details are loaded successfully.","schema":{"$ref":"#/definitions/UserIdentityResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/search":{"post":{"tags":["User"],"summary":"Get user list by role or user id","description":"

This API endpoint gives you the list of available users in your company based on a given role guid or list of users guid. You can only send either roleGuid or a list of users guid.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string. The status parameter is used to get the list of users based on their active status. The property parameter is used to get the list of users with properties available.

","parameters":[{"name":"property","in":"query","description":"To include or exclude user properties from list, if any. true : To include properties, false : To exclude properties","type":"boolean"},{"name":"status","in":"query","description":"To get the list of users based on their active status. true : For active users list, false : For inactive users list","type":"boolean"},{"name":"pageNumber","in":"query","description":"To fetch specific page data. eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. eg: 25","type":"integer","format":"int32"},{"name":"searchText","in":"query","description":"To search for specific texts in the list.","type":"string"},{"name":"sortBy","in":"query","description":"To sort the list. To do that, Specify Field name to sort with and sorting order. eg: firstName asc","type":"string"},{"name":"request","in":"body","description":"Enter either Role Guids or User Guids","schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user list is loaded successfully.","schema":{"$ref":"#/definitions/UserSearchResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/count":{"get":{"tags":["User"],"summary":"Get user count","description":"

This API endpoint gives you the count of available users in your company.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string. companyGuid parameter is used to get the list of users for a given company guid. The status parameter is used to get the list of users based on their active status.

","parameters":[{"name":"companyGuid","in":"query","description":"Company Guid","type":"string","format":"uuid"},{"name":"status","in":"query","description":"To get user count based on user active status. active : To get active user count, inactive : To get inactive user count.","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user count is received successfully.","schema":{"$ref":"#/definitions/UserCountValueResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/{email}/availability":{"get":{"tags":["User"],"summary":"Get user availability","description":"

This API endpoint provides you the user’s availability details. For that, you need to send a user login email id in request url. If a user is available, it will give the user details.

","parameters":[{"name":"email","in":"path","description":"User's Login Email Id","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user is available and returns user detail.","schema":{"$ref":"#/definitions/UserAvailabilityUsingEmailResponse"}},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nUser doesn't exist etc."}}}},"/api/v2.1/entity/{entityGuid}/user-import":{"post":{"tags":["User"],"summary":"Import users in batch","description":"

This API endpoint allows you to create users in bulk for a given entity guid. For that, you need to upload a CSV file in userFile parameter, containing a list of users that you want to create under the given entity.

","parameters":[{"name":"entityGuid","in":"path","description":"Entity Guid. All users will be created under this entity.","required":true,"type":"string","format":"uuid"},{"name":"UserFile","in":"formData","description":"Json file as per the file sample provided. Please download sample files form your IoTConnect Account.Upload a file containing a list of users to import.","type":"file","required":false},{"name":"SendInvitationEmail","in":"formData","description":"To receive invitation email from IDS","type":"boolean","required":false},{"name":"ChunkFileGuid","in":"formData","description":"","type":"string","required":false}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user batch is imported successfully.","schema":{"$ref":"#/definitions/UserBulkUploadResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}},"/api/v2.1/User/announcement":{"get":{"tags":["User"],"summary":"Get user's announcement list","description":"","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/AnnouncementDetailResponse"}}}},"post":{"tags":["User"],"summary":"","description":"","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/AnnouncementResponse"}}},"parameters":[{"name":"request","in":"body","description":"","schema":{"$ref":"#/definitions/AnnouncementRequest"}}]}},"/api/v2.1/User/Notification":{"get":{"tags":["User"],"summary":"Get user NotificationList","description":"

This API endpoint gives you the list of notifications for a specific userId.

\n

You can get a list of notifications based on your selection of preferences.

","parameters":[{"name":"userId","in":"query","type":"string"},{"name":"deliveryMethod","in":"query","type":"integer","format":"int32"},{"name":"companyGuid","in":"query","type":"string","format":"uuid"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationListResponse"}}}}},"/api/v2.1/User/m-notification":{"get":{"tags":["User"],"summary":"Get Registered Platform NotificationList","description":"

This API endpoint gives you the list of notifications for a specific registered device.

\n

You can get notifications based on your user id.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/GetMobileNotificationListResponse"}}}}},"/api/v2.1/User/deviceToken/{deviceToken}/minutes/{minutes}/snooze":{"put":{"tags":["User"],"summary":"Snooze the Notification for specific device","description":"

This API endpoint gives you the list of notifications for a specific registered device.

\n

You can get a list of notifications based on your device token.

","parameters":[{"name":"minutes","in":"path","required":true,"type":"integer","format":"int32"},{"name":"deviceToken","in":"path","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/SnoozeNotificationResponse"}}}}},"/api/v2.1/User/m-register/platform/{platformType}/deviceToken/{deviceToken}":{"put":{"tags":["User"],"summary":"RegisterDevice Platform","description":"

This API endpoint will register the device platform based on the device token and platform you passed.

","parameters":[{"name":"platformType","in":"path","description":"Platform type should be one of below items\n","required":true,"type":"integer","format":"int32"},{"name":"deviceToken","in":"path","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/RegisterPlatformResponse"}}}},"delete":{"tags":["User"],"summary":"Remove the RegisterDevice Platform","description":"

This API endpoint will remove the device platform based on the device token and platform you provided.

","parameters":[{"name":"platformType","in":"path","description":"Platform type should be one of below items\n","required":true,"type":"integer","format":"int32"},{"name":"deviceToken","in":"path","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/RegisterPlatformDeleteResponse"}}}}},"/api/v2.1/User/enumDetail":{"get":{"tags":["User"],"summary":"Get Enum Description","description":"

This API endpoint gives you a list of enum values with a description of the ResourceHealthAlert enum.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/GetEnumDataResponse"}}}}},"/api/v2.1/User/rh-Config":{"get":{"tags":["User"],"summary":"Get RHApp Configuration","description":"

This API endpoint allows you to get RhApp Congiuration for Both Platform Andorid and iOS.\n

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"OK","schema":{"$ref":"#/definitions/RhConfigResponse"}}}}},"/api/v2.1/cognito/user":{"get":{"tags":["User"],"summary":"Get Cognito user list","description":"

This API endpoint provides you the list of cognito users in your company.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"Email","in":"query","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that user list is loaded successfully.","schema":{"$ref":"#/definitions/CognitoUserListResponse"}},"204":{"description":"Indicates that the request has been successfully processed and no records found.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"403":{"description":"Indicates that the user is not authorized to access this section."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server\nCompany doesn't exist, Logged in user is not valid etc."}}}}},"security":[{"Bearer":[]}],"tags":[{"name":"Entity","description":"Entity Api List"},{"name":"Role","description":"Role Api List"},{"name":"User","description":"User Api List"}],"swagger":"2.0","definitions":{"AnnouncementDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"Title":{"type":"string","nullable":true},"Description":{"type":"string","nullable":true},"announcementType":{"type":"string","nullable":true}},"additionalProperties":false},"AnnouncementDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/AnnouncementDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"AnnouncementRequest":{"type":"object","properties":{"announcementGuid":{"type":"array","items":{"type":"string"},"description":"Announcement Guid","nullable":true}},"additionalProperties":false},"AnnouncementResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"AuthenticationFeatures":{"type":"object","properties":{"authType":{"type":"string","nullable":true},"features":{"nullable":true}},"additionalProperties":false},"ChangePasswordRequest":{"required":["email","newPassword","oldPassword"],"type":"object","properties":{"email":{"minLength":1,"type":"string","description":"User's login email Id. eg: abc@gmail.com"},"oldPassword":{"minLength":1,"type":"string","description":"Old login password."},"newPassword":{"minLength":1,"type":"string","description":"New login password."}},"additionalProperties":false},"CognitoUserGetList":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"contactNo":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isVerified":{"type":"boolean"}},"additionalProperties":false},"CognitoUserListResponse":{"type":"object","properties":{"invokingUser":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/definitions/CognitoUserGetList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityBulkImportCancelResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityBulkImportListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityImportHistory"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityBulkImportValidateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityImportBulkStatus"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityCreateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityCreateResult"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityCreateResult":{"type":"object","properties":{"entityGuid":{"type":"string","nullable":true,"readOnly":true},"invitationGuid":{"type":"string","nullable":true,"readOnly":true},"userGuid":{"type":"string","nullable":true,"readOnly":true},"isExistingUser":{"type":"boolean"},"isWelcomeEmail":{"type":"boolean","nullable":true}},"additionalProperties":false},"EntityCreateV2Request":{"required":["name","parentEntityGuid"],"type":"object","properties":{"name":{"maxLength":100,"minLength":1,"type":"string","description":"Entity Name"},"description":{"maxLength":500,"type":"string","description":"Entity Description","nullable":true},"parentEntityGuid":{"minLength":1,"type":"string","description":"Parent Entity Guid"},"childEntityLabel":{"maxLength":50,"type":"string","nullable":true},"address":{"maxLength":500,"type":"string","description":"Entity Address","nullable":true},"address2":{"maxLength":500,"type":"string","description":"Entity Address 2","nullable":true},"city":{"maxLength":50,"type":"string","description":"City Name","nullable":true},"stateGuid":{"type":"string","description":"State Guid. You can fetch country wise state list from Master API","nullable":true},"countryGuid":{"type":"string","description":"Country Guid. You can fetch country list from Master API","nullable":true},"zipCode":{"maxLength":50,"type":"string","description":"Zip Code","nullable":true},"timezoneGuid":{"type":"string","description":"Timezone Guid. You can fetch timezone list from Master API","nullable":true},"userInfo":{"$ref":"#/definitions/UserInfo"},"userInfoXml":{"type":"object","nullable":true,"readOnly":true}},"additionalProperties":false},"EntityDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"parentEntityGuid":{"type":"string","nullable":true,"readOnly":true},"description":{"type":"string","nullable":true},"childEntityLabel":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"isDeleted":{"type":"boolean"},"createdDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedDate":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"address":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"stateGuid":{"type":"string","nullable":true,"readOnly":true},"countryGuid":{"type":"string","nullable":true,"readOnly":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"defaultuserGuid":{"type":"string","nullable":true,"readOnly":true},"zipCode":{"type":"string","nullable":true},"address2":{"type":"string","nullable":true},"entityInfo":{"type":"object","nullable":true}},"additionalProperties":false},"EntityDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityImportBulkStatus":{"type":"object","properties":{"importBatchGuid":{"type":"string","nullable":true,"readOnly":true},"isValid":{"type":"boolean"}},"additionalProperties":false},"EntityImportHistory":{"type":"object","properties":{"entityGuid":{"type":"string","format":"uuid"},"guid":{"type":"string","format":"uuid"},"fileName":{"type":"string","nullable":true},"entityName":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid"},"createdByName":{"type":"string","nullable":true},"updatedDate":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","format":"uuid"},"success":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"isValidBatch":{"type":"boolean"},"companyName":{"type":"string","nullable":true}},"additionalProperties":false},"EntityList":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"parentEntityGuid":{"type":"string","nullable":true,"readOnly":true},"parentName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"childEntityLabel":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"activeUserCount":{"type":"integer","format":"int32"},"inActiveUserCount":{"type":"integer","format":"int32"},"deviceCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"EntityListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityLookup":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"parentEntityGuid":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"EntityLookupResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityLookup"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EntityPropertiesUpdateRequest":{"type":"object","properties":{"properties":{"type":"array","items":{"$ref":"#/definitions/PropertyValue"},"description":"Custom Properties","nullable":true},"xmlProperties":{"type":"object","nullable":true,"readOnly":true}},"additionalProperties":false},"EntityUpdate":{"type":"object","properties":{"userGuid":{"type":"string","nullable":true,"readOnly":true},"invitationGuid":{"type":"string","nullable":true,"readOnly":true},"isExistingUser":{"type":"boolean"},"isWelcomeEmail":{"type":"boolean","nullable":true}},"additionalProperties":false},"EntityUpdateRequest":{"required":["name","parentEntityGuid"],"type":"object","properties":{"ownerUserGuid":{"type":"string","description":"Entity owner user guid","nullable":true},"isRemoveEntityOwner":{"type":"boolean","default":false},"name":{"maxLength":100,"minLength":1,"type":"string","description":"Entity Name"},"description":{"maxLength":500,"type":"string","description":"Entity Description","nullable":true},"parentEntityGuid":{"minLength":1,"type":"string","description":"Parent Entity Guid"},"childEntityLabel":{"maxLength":50,"type":"string","nullable":true},"address":{"maxLength":500,"type":"string","description":"Entity Address","nullable":true},"address2":{"maxLength":500,"type":"string","description":"Entity Address 2","nullable":true},"city":{"maxLength":50,"type":"string","description":"City Name","nullable":true},"stateGuid":{"type":"string","description":"State Guid. You can fetch country wise state list from Master API","nullable":true},"countryGuid":{"type":"string","description":"Country Guid. You can fetch country list from Master API","nullable":true},"zipCode":{"maxLength":50,"type":"string","description":"Zip Code","nullable":true},"timezoneGuid":{"type":"string","description":"Timezone Guid. You can fetch timezone list from Master API","nullable":true},"userInfo":{"$ref":"#/definitions/UserInfo"},"userInfoXml":{"type":"object","nullable":true,"readOnly":true}},"additionalProperties":false},"EntityUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EntityUpdate"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EnumDetails":{"type":"object","properties":{"description":{"type":"string","nullable":true},"value":{"type":"integer","format":"int32"}},"additionalProperties":false},"Error":{"type":"object","properties":{"user":{"$ref":"#/definitions/UserUploadData"}},"additionalProperties":false},"ErrorModel":{"type":"object","properties":{"param":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorsResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"error":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"},"nullable":true}},"additionalProperties":false},"ForgotPasswordRequest":{"required":["email"],"type":"object","properties":{"email":{"minLength":1,"type":"string","description":"User's login email Id. eg: abc@gmail.com"},"sendTempPassword":{"type":"boolean","description":"Send true to receive temp password email from IDS"}},"additionalProperties":false},"GetEnumDataResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EnumDetails"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"GetMobileNotificationListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/MobileNotification"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"MobileNotification":{"type":"object","properties":{"userGuid":{"type":"string","format":"uuid"},"userId":{"type":"string","nullable":true},"notificationText":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"alertType":{"type":"integer","format":"int32"}},"additionalProperties":false},"NoContentResult":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"}},"additionalProperties":false},"NotificationListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserListNotification"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"PreferenceUpdateRequest":{"required":["emailNotification","languageGuid","pageSize","pushNotification","smsNotification","timeZoneGuid"],"type":"object","properties":{"timeZoneGuid":{"minLength":1,"type":"string","description":"Timezone Guid. You can fetch timezone list from Master API."},"emailNotification":{"type":"boolean","description":"true or false. To turn on/off email notifications."},"emailNotifyOn":{"type":"integer","description":"Email notification preference. 0: to receive emails on primary email id, 1: to receive emails on alternate email id.","format":"int32","nullable":true},"alternateEmailID":{"type":"string","description":"To receive email notifications on secondary email address. if emailNotifyOn is 1.","nullable":true},"smsNotification":{"type":"boolean","description":"true or false. To turn on/off sms notifications."},"pushNotification":{"type":"boolean","description":"true or false. To turn on/off push notifications."},"pageSize":{"type":"integer","description":"Your preference for number of records in one page. eg: 25","format":"int32"},"platformEmails":{"type":"integer","description":"Your preference for PlatformEmails.Store BIT wise sum or the value of email types","format":"int32","nullable":true},"oldView":{"type":"boolean","description":"true or false. To switch from old and new UI view.","default":false},"languageGuid":{"minLength":1,"type":"string","description":"Language Guid.You can fetch language list from Master API."},"rhSetting":{"type":"integer","format":"int32"},"alwaysShowFilter":{"type":"boolean","default":false}},"additionalProperties":false},"Property":{"type":"object","properties":{"key":{"type":"string","description":"Custom property key","nullable":true},"value":{"type":"string","description":"Custom property value","nullable":true}},"additionalProperties":false},"PropertyValue":{"required":["guid","value"],"type":"object","properties":{"guid":{"minLength":1,"type":"string","description":"Custom Property Guid"},"value":{"minLength":1,"type":"string","description":"Custom Property Value"}},"additionalProperties":false},"Propertys":{"type":"object","properties":{"guid":{"type":"string","description":"Property Guid","nullable":true},"value":{"type":"string","description":"Property Value","nullable":true}},"additionalProperties":false},"RegisterPlatformDeleteResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RegisterPlatformResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"ResendResetPasswordRequest":{"type":"object","properties":{"email":{"type":"string","description":"User's login email Id. eg: abc@gmail.com","nullable":true}},"additionalProperties":false},"ResetPasswordRequest":{"required":["email","invitationguid","newpassword"],"type":"object","properties":{"email":{"minLength":1,"type":"string","description":"User's Login email Id. eg: abc@gmail.com"},"invitationguid":{"minLength":1,"type":"string","description":"Invitation Guid"},"newpassword":{"minLength":1,"type":"string","description":"New login password"}},"additionalProperties":false},"RhAppConfiguration":{"type":"object","properties":{"androidApp":{"type":"string","nullable":true},"IOSApp":{"type":"string","nullable":true},"enable":{"type":"integer","format":"int32"}},"additionalProperties":false},"RhConfigResponse":{"type":"object","properties":{"data":{"$ref":"#/definitions/RhAppConfiguration"},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RoleCreate":{"type":"object","properties":{"newId":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"RoleCreateRequest":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":1,"type":"string","description":"Role Name"},"description":{"maxLength":500,"type":"string","description":"Role Description","nullable":true},"solutions":{"type":"array","items":{"type":"string"},"description":"Solution guid list","nullable":true}},"additionalProperties":false},"RoleCreateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/RoleCreate"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RoleDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"solutions":{"type":"object","nullable":true,"readOnly":true}},"additionalProperties":false},"RoleDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/RoleDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RoleList":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"description":{"type":"object","nullable":true},"isActive":{"type":"boolean"},"row_num":{"type":"integer","format":"int32"}},"additionalProperties":false},"RoleListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/RoleList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RoleListWithUserCount":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"updatedByName":{"type":"string","nullable":true},"isactive":{"type":"boolean"},"userCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"RoleListWithUserCountResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/RoleListWithUserCount"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RoleStatusUpdateV2Request":{"required":["isActive"],"type":"object","properties":{"isActive":{"minLength":1,"type":"string","description":"Updated active status. true: Active, false: Inactive"}},"additionalProperties":false},"RoleUpdateRequest":{"required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":1,"type":"string","description":"Role Name"},"description":{"maxLength":500,"type":"string","description":"Role Description","nullable":true},"solutions":{"type":"array","items":{"type":"string"},"description":"Solution guid list","nullable":true}},"additionalProperties":false},"SnoozeNotificationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"SuccessDataResponse":{"type":"object","properties":{"user":{"$ref":"#/definitions/UserDataSuccessResponse"}},"additionalProperties":false},"SuccessResponse":{"type":"object","properties":{"message":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true}},"additionalProperties":false},"UserAdd":{"type":"object","properties":{"newId":{"type":"string","nullable":true,"readOnly":true},"invitationGuid":{"type":"string","nullable":true,"readOnly":true},"isExistingUser":{"type":"boolean"},"isWelcomeEmail":{"type":"boolean","nullable":true}},"additionalProperties":false},"UserAvailabilityUsingEmail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"imageName":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isDeleted":{"type":"boolean"},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"isPasswordCreated":{"type":"integer","format":"int32"}},"additionalProperties":false},"UserAvailabilityUsingEmailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserAvailabilityUsingEmail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserBulkUploadResponse":{"type":"object","properties":{"isWelcomeEmail":{"type":"boolean","nullable":true},"data":{"type":"array","items":{"$ref":"#/definitions/Userdata"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserChangePasswordResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserResetPasswordTemplate"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserCountValue":{"type":"object","properties":{"userCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"UserCountValueResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserCountValue"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserCreateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserAdd"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserCreateV2Request":{"required":["entityGuid","firstName","isActive","lastName","roleGuid","timezoneGuid","userId"],"type":"object","properties":{"userId":{"minLength":1,"type":"string","description":"User's login email id. eg: abc@gmail.com"},"isTempPassword":{"type":"boolean","description":"To enable/disable IDS temp password for user, Send true to enable and false to disable.","nullable":true},"isActive":{"type":"integer","description":"User's active status. 1: Active, 0: Inactive","format":"int32"},"sendInvitationEmail":{"type":"boolean","description":"To receive invitation email from IDS","nullable":true},"password":{"type":"string","nullable":true},"properties":{"type":"array","items":{"$ref":"#/definitions/Property"},"description":"Custom properties allows you to add additional information about user. You can add multiple custom properties.","nullable":true},"xmlProperties":{"type":"object","nullable":true,"readOnly":true},"userGuid":{"type":"string","format":"uuid","nullable":true},"firstName":{"minLength":1,"type":"string","description":"User's first name"},"lastName":{"minLength":1,"type":"string","description":"User's last name"},"timezoneGuid":{"minLength":1,"type":"string","description":"Timezone Guid. You can fetch timezone list from Master API"},"contactNo":{"type":"string","description":"User's contact no. eg: 91-1234567890","nullable":true},"roleGuid":{"minLength":1,"type":"string","description":"Role Guid"},"entityGuid":{"minLength":1,"type":"string","description":"Entity Guid"}},"additionalProperties":false},"UserDataSuccessResponse":{"type":"object","properties":{"firstname":{"type":"string","nullable":true},"lastname":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"rolename":{"type":"string","nullable":true},"properties":{"type":"object","nullable":true},"userGuid":{"type":"string","nullable":true,"readOnly":true},"invitationGuid":{"type":"string","nullable":true,"readOnly":true},"isExistingUser":{"type":"boolean"}},"additionalProperties":false},"UserDelete":{"type":"object","properties":{"userguid":{"type":"string","nullable":true,"readOnly":true},"eventPlaceHolders":{"type":"string","nullable":true}},"additionalProperties":false},"UserDeleteRequest":{"type":"object","additionalProperties":false},"UserDeleteResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserDelete"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserDetailsById":{"type":"object","properties":{"userGuid":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"imageName":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"roleName":{"type":"string","nullable":true},"roleGuid":{"type":"string","nullable":true,"readOnly":true},"contactNo":{"type":"string","nullable":true},"entityName":{"type":"string","nullable":true},"userInfo":{"type":"array","items":{"$ref":"#/definitions/UserinfoValues"},"nullable":true,"readOnly":true},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"updatedByName":{"type":"string","nullable":true},"createdDate":{"type":"string","nullable":true},"updatedDate":{"type":"string","nullable":true},"entityGuid":{"type":"string","nullable":true,"readOnly":true},"parentEntityGuid":{"type":"string","nullable":true,"readOnly":true},"companyLogo":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"companyCpid":{"type":"string","nullable":true},"timezoneOffset":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true,"readOnly":true},"companyLogoUrl":{"type":"string","nullable":true,"readOnly":true},"dms-version":{"type":"string","nullable":true},"isCompanyAdmin":{"type":"boolean"}},"additionalProperties":false},"UserForgetPasswordResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserInvitationDetails"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserGetList":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"contactNo":{"type":"string","nullable":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"imageName":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isVerified":{"type":"boolean"},"isLocked":{"type":"boolean"},"userInfo":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"roleGuid":{"type":"string","nullable":true,"readOnly":true},"roleName":{"type":"string","nullable":true},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"entityGuid":{"type":"string","nullable":true,"readOnly":true},"entityName":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true,"readOnly":true},"invitationguid":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"UserGetListResponse":{"type":"object","properties":{"invokingUser":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/definitions/UserGetList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserIdentity":{"type":"object","properties":{"companyLogo":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"version":{"type":"string","nullable":true},"uiVersion":{"type":"string","nullable":true},"parentEntityGuid":{"type":"string","format":"uuid","nullable":true},"pageSize":{"type":"integer","format":"int32"},"userGuid":{"type":"string","nullable":true,"readOnly":true},"roleGuid":{"type":"string","nullable":true,"readOnly":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"companyLogoUrl":{"type":"string","nullable":true},"permissions":{"type":"object","nullable":true},"companyName":{"type":"string","nullable":true},"roleName":{"type":"string","nullable":true},"cpId":{"type":"string","nullable":true},"entityGuid":{"type":"string","nullable":true},"solutionGuid":{"type":"string","nullable":true},"isCompanyAdmin":{"type":"boolean"},"authFeatures":{"$ref":"#/definitions/AuthenticationFeatures"},"configSettings":{"type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"userId":{"type":"string","nullable":true},"isDefaultDashboard":{"type":"boolean"},"isServiceAccountEnabled":{"type":"boolean"},"instanceSize":{"type":"string","nullable":true},"companyType":{"type":"integer","format":"int32"},"reviewStatus":{"type":"string","nullable":true},"oldView":{"type":"boolean"},"languageGuid":{"type":"string","nullable":true,"readOnly":true},"cd":{"type":"string","nullable":true},"systemRole":{"type":"boolean"}},"additionalProperties":false},"UserIdentityResponse":{"type":"object","properties":{"data":{"$ref":"#/definitions/UserIdentity"},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserInfo":{"type":"object","properties":{"firstName":{"maxLength":50,"type":"string","description":"User's first name","nullable":true},"lastName":{"maxLength":50,"type":"string","description":"User's last name","nullable":true},"userId":{"maxLength":100,"type":"string","description":"User's login email id. eg: abc@gmail.com","nullable":true},"timezoneGuid":{"type":"string","description":"Timezone Guid. You can fetch timezone list from Master API","nullable":true},"roleGuid":{"type":"string","description":"Role Guid","nullable":true},"contactNo":{"type":"string","description":"User's contact no. eg: 91-1234567890","nullable":true},"properties":{"type":"array","items":{"$ref":"#/definitions/Property"},"description":"Custom properties allows you to add additional information about user. You can add multiple custom properties.","nullable":true},"isActive":{"type":"boolean","description":"User's active status. true: Active, false: Inactive","nullable":true},"sendInvitationEmail":{"type":"boolean","description":"To receive invitation email from IDS","nullable":true},"password":{"type":"string","description":"To set password directly without reset password","nullable":true},"isTempPassword":{"type":"boolean","description":"To enable/disable IDS temp password for user, Send true to enable and false to disable.","nullable":true}},"additionalProperties":false},"UserInvitationDetails":{"type":"object","properties":{"userGuid":{"type":"string","nullable":true,"readOnly":true},"invitationGuid":{"type":"string","nullable":true,"readOnly":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"eventPlaceHolders":{"type":"string","nullable":true},"invokingUser":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"UserListByEntity":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"contactNo":{"type":"string","nullable":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"imageName":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isVerified":{"type":"boolean"},"userInfo":{"type":"array","items":{"$ref":"#/definitions/Userinfo"},"nullable":true},"roleGuid":{"type":"string","nullable":true,"readOnly":true},"roleName":{"type":"string","nullable":true},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"entityGuid":{"type":"string","nullable":true,"readOnly":true},"entityName":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"isLocked":{"type":"boolean"}},"additionalProperties":false},"UserListByEntityResponse":{"type":"object","properties":{"invokingUser":{"type":"string","nullable":true,"readOnly":true},"data":{"type":"array","items":{"$ref":"#/definitions/UserListByEntity"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserListNotification":{"type":"object","properties":{"userGuid":{"type":"string","format":"uuid"},"userId":{"type":"string","nullable":true},"notificationText":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"alertType":{"type":"integer","format":"int32"}},"additionalProperties":false},"UserLookup":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"userid":{"type":"string","nullable":true}},"additionalProperties":false},"UserLookupResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserLookup"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserPreferenceList":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"timeZoneGuid":{"type":"string","nullable":true,"readOnly":true},"emailNotification":{"type":"boolean"},"emailNotifyOn":{"type":"integer","format":"int32"},"alternateEmailID":{"type":"string","nullable":true},"smsNotification":{"type":"boolean"},"pushNotification":{"type":"boolean"},"pageSize":{"type":"integer","format":"int32"},"platformEmails":{"type":"integer","format":"int32"},"oldView":{"type":"boolean"},"languageGuid":{"type":"string","nullable":true,"readOnly":true},"rhSetting":{"type":"integer","format":"int32","nullable":true},"notificationSetting":{"type":"string","nullable":true},"alwaysShowFilter":{"type":"boolean"}},"additionalProperties":false},"UserPreferenceListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserPreferenceList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserPreferenceUpdate":{"type":"object","properties":{"userGuid":{"type":"string","nullable":true,"readOnly":true},"preferenceAction":{"type":"string","nullable":true},"userPreferenceGuid":{"type":"string","nullable":true,"readOnly":true},"emailNotification":{"type":"boolean"},"smsNotification":{"type":"boolean"},"alternateEmailID":{"type":"string","nullable":true},"pushNotification":{"type":"boolean"},"pageSize":{"type":"integer","format":"int32"},"rhSetting":{"type":"integer","format":"int32"}},"additionalProperties":false},"UserPreferenceUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserPreferenceUpdate"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserPropertiesUpdateRequest":{"type":"object","properties":{"properties":{"type":"array","items":{"$ref":"#/definitions/Propertys"},"nullable":true}},"additionalProperties":false},"UserPropertyDelete":{"type":"object","additionalProperties":false},"UserPropertyDeleteResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserPropertyDelete"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserPropertyUpdate":{"type":"object","additionalProperties":false},"UserPropertyUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserPropertyUpdate"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserResetPasswordResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserInvitationDetails"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserResetPasswordTemplate":{"type":"object","properties":{"eventPlaceHolders":{"type":"string","nullable":true}},"additionalProperties":false},"UserResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserDetailsById"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserSearch":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"userId":{"type":"string","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"timezoneGuid":{"type":"string","nullable":true,"readOnly":true},"imageName":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isVerified":{"type":"boolean"},"userInfo":{"type":"object","nullable":true},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true},"createdDate":{"type":"string","format":"date-time"},"updatedDate":{"type":"string","format":"date-time"},"contactNo":{"type":"string","nullable":true},"roleName":{"type":"string","nullable":true}},"additionalProperties":false},"UserSearchRequest":{"type":"object","properties":{"userguids":{"type":"array","items":{"$ref":"#/definitions/userguid"},"description":"User Guid List","nullable":true},"roleguids":{"type":"array","items":{"$ref":"#/definitions/roleguid"},"description":"Role Guid List","nullable":true}},"additionalProperties":false},"UserSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserSearch"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserStatusChangeV2Request":{"required":["isActive"],"type":"object","properties":{"isActive":{"minLength":1,"type":"string","description":"Updated active status. true: to activate user, false: to deactivate user."}},"additionalProperties":false},"UserUpdateByID":{"type":"object","properties":{"roleUserGuid ":{"type":"string","nullable":true,"readOnly":true},"isActive":{"type":"boolean"},"userId":{"type":"string","nullable":true},"roleGuid ":{"type":"string","nullable":true,"readOnly":true},"isUpdateRole":{"type":"boolean"},"entityGuid ":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"UserUpdateRequest":{"required":["entityGuid","firstName","lastName","roleGuid","timezoneGuid"],"type":"object","properties":{"properties":{"type":"array","items":{"$ref":"#/definitions/PropertyValue"},"description":"Custom properties allows you to add additional information about user. You can add multiple custom properties.","nullable":true},"xmlProperties":{"type":"object","nullable":true,"readOnly":true},"firstName":{"minLength":1,"type":"string","description":"User's first name"},"lastName":{"minLength":1,"type":"string","description":"User's last name"},"timezoneGuid":{"minLength":1,"type":"string","description":"Timezone Guid. You can fetch timezone list from Master API"},"contactNo":{"type":"string","description":"User's contact no. eg: 91-1234567890","nullable":true},"roleGuid":{"minLength":1,"type":"string","description":"Role Guid"},"entityGuid":{"minLength":1,"type":"string","description":"Entity Guid"}},"additionalProperties":false},"UserUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/UserUpdateByID"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UserUploadData":{"type":"object","properties":{"firstname":{"type":"string","nullable":true},"lastname":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"rolename":{"type":"string","nullable":true},"properties":{"type":"object","nullable":true},"errorLog":{"type":"string","nullable":true}},"additionalProperties":false},"Userdata":{"type":"object","properties":{"error":{"type":"array","items":{"$ref":"#/definitions/Error"},"nullable":true},"success":{"type":"array","items":{"$ref":"#/definitions/SuccessDataResponse"},"nullable":true}},"additionalProperties":false},"Userinfo":{"type":"object","properties":{"guid":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fieldType":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"options":{"type":"string","nullable":true}},"additionalProperties":false},"UserinfoValues":{"type":"object","properties":{"guid":{"type":"string","nullable":true},"name":{"type":"string","nullable":true,"readOnly":true},"options":{"type":"string","nullable":true,"readOnly":true},"fieldType":{"type":"string","nullable":true},"value":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"roleguid":{"type":"object","properties":{"guid":{"type":"string","description":"Role Guid","nullable":true}},"additionalProperties":false},"userguid":{"type":"object","properties":{"guid":{"type":"string","description":"User Guid","nullable":true}},"additionalProperties":false}},"securityDefinitions":{"Bearer":{"type":"apiKey","description":"Please enter JWT with Bearer into field","name":"Authorization","in":"header"}}}