GET api/v1/account/users?locationId={locationId}&inputFilter={inputFilter}&partitionID={partitionID}
Get All users Input Filter Values Info. 0 -- Renote Login Users on all locations -1 -- Panel Only Users on all locations -2 -- All users on all locations -3 -- Users out of sync on all locations
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
Location ID |
integer |
Required |
inputFilter |
Input Filter |
integer |
Required |
partitionID |
Input Filter |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
UserDetailsResultsName | Description | Type | Additional information |
---|---|---|---|
UserManagementOptions | UserManagementOptions |
None. |
|
Users | Collection of UserDetailsExV1 |
None. |
|
UrgentSyncCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserManagementOptions": { "IsOptedForUserCodeManagement": true, "IsUserCodeDisplayed": true }, "Users": [ { "UserId": 1, "UserName": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Enabled": true, "IsValidated": true, "FeatureInfo": [ { "FeatureId": 64, "FeatureName": "sample string 2" }, { "FeatureId": 64, "FeatureName": "sample string 2" } ], "FeatureIds": [ "sample string 1", "sample string 2" ], "TimeStampUpdate": "2025-04-01T23:39:29.4407976-04:00", "ImageId": 8, "PhotoUrl": "sample string 9", "UserTypeId": 64, "OutOfSyncCount": 64, "IsDuplicateUserCode": true, "IsPartitionManager": true, "LastLoggedTime": "sample string 14", "GlobalArm": 15, "OpenCloseReport": 16 }, { "UserId": 1, "UserName": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Enabled": true, "IsValidated": true, "FeatureInfo": [ { "FeatureId": 64, "FeatureName": "sample string 2" }, { "FeatureId": 64, "FeatureName": "sample string 2" } ], "FeatureIds": [ "sample string 1", "sample string 2" ], "TimeStampUpdate": "2025-04-01T23:39:29.4407976-04:00", "ImageId": 8, "PhotoUrl": "sample string 9", "UserTypeId": 64, "OutOfSyncCount": 64, "IsDuplicateUserCode": true, "IsPartitionManager": true, "LastLoggedTime": "sample string 14", "GlobalArm": 15, "OpenCloseReport": 16 } ], "UrgentSyncCount": 1 }
application/xml, text/xml
Sample:
<UserDetailsResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.UserConfiguration"> <UrgentSyncCount>1</UrgentSyncCount> <UserManagementOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.UserConfiguration"> <d2p1:IsOptedForUserCodeManagement>true</d2p1:IsOptedForUserCodeManagement> <d2p1:IsUserCodeDisplayed>true</d2p1:IsUserCodeDisplayed> </UserManagementOptions> <Users xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.UserConfiguration"> <d2p1:UserDetailsExV1> <d2p1:Enabled>true</d2p1:Enabled> <d2p1:FeatureIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </d2p1:FeatureIds> <d2p1:FeatureInfo> <d2p1:UserFeatureInfo> <d2p1:FeatureId>64</d2p1:FeatureId> <d2p1:FeatureName>sample string 2</d2p1:FeatureName> </d2p1:UserFeatureInfo> <d2p1:UserFeatureInfo> <d2p1:FeatureId>64</d2p1:FeatureId> <d2p1:FeatureName>sample string 2</d2p1:FeatureName> </d2p1:UserFeatureInfo> </d2p1:FeatureInfo> <d2p1:FirstName>sample string 3</d2p1:FirstName> <d2p1:GlobalArm>15</d2p1:GlobalArm> <d2p1:ImageId>8</d2p1:ImageId> <d2p1:IsDuplicateUserCode>true</d2p1:IsDuplicateUserCode> <d2p1:IsPartitionManager>true</d2p1:IsPartitionManager> <d2p1:IsValidated>true</d2p1:IsValidated> <d2p1:LastLoggedTime>sample string 14</d2p1:LastLoggedTime> <d2p1:LastName>sample string 4</d2p1:LastName> <d2p1:OpenCloseReport>16</d2p1:OpenCloseReport> <d2p1:OutOfSyncCount>64</d2p1:OutOfSyncCount> <d2p1:PhotoUrl>sample string 9</d2p1:PhotoUrl> <d2p1:TimeStampUpdate>2025-04-01T23:39:29.4407976-04:00</d2p1:TimeStampUpdate> <d2p1:UserId>1</d2p1:UserId> <d2p1:UserName>sample string 2</d2p1:UserName> <d2p1:UserTypeId>64</d2p1:UserTypeId> </d2p1:UserDetailsExV1> <d2p1:UserDetailsExV1> <d2p1:Enabled>true</d2p1:Enabled> <d2p1:FeatureIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </d2p1:FeatureIds> <d2p1:FeatureInfo> <d2p1:UserFeatureInfo> <d2p1:FeatureId>64</d2p1:FeatureId> <d2p1:FeatureName>sample string 2</d2p1:FeatureName> </d2p1:UserFeatureInfo> <d2p1:UserFeatureInfo> <d2p1:FeatureId>64</d2p1:FeatureId> <d2p1:FeatureName>sample string 2</d2p1:FeatureName> </d2p1:UserFeatureInfo> </d2p1:FeatureInfo> <d2p1:FirstName>sample string 3</d2p1:FirstName> <d2p1:GlobalArm>15</d2p1:GlobalArm> <d2p1:ImageId>8</d2p1:ImageId> <d2p1:IsDuplicateUserCode>true</d2p1:IsDuplicateUserCode> <d2p1:IsPartitionManager>true</d2p1:IsPartitionManager> <d2p1:IsValidated>true</d2p1:IsValidated> <d2p1:LastLoggedTime>sample string 14</d2p1:LastLoggedTime> <d2p1:LastName>sample string 4</d2p1:LastName> <d2p1:OpenCloseReport>16</d2p1:OpenCloseReport> <d2p1:OutOfSyncCount>64</d2p1:OutOfSyncCount> <d2p1:PhotoUrl>sample string 9</d2p1:PhotoUrl> <d2p1:TimeStampUpdate>2025-04-01T23:39:29.4407976-04:00</d2p1:TimeStampUpdate> <d2p1:UserId>1</d2p1:UserId> <d2p1:UserName>sample string 2</d2p1:UserName> <d2p1:UserTypeId>64</d2p1:UserTypeId> </d2p1:UserDetailsExV1> </Users> </UserDetailsResults>