Get list of users

The request without parameters returns the list of all users of the System.

By default, the search result is entered page by page, with no more than 1000 users on each page. You can increase this number up to 10000 by specifying the value of the timeout parameter.

You can filter users using a parameter from the OBJ_PERSON table (see Database tables reference guide for Axxon PSIM and vertical solutions). Examples of parameters are given in the table below.

You can use the search parameter to search for users by parameter value or part of it.

All users are returned in order of increasing id.

General request format:

GET http://IP address:port/web2/secure/persons?id={id}

Examples of request parameters:

Parameter	Required	Description
name	No	Surname
id	No	User ID
guid	No	User GUID
card	No	Card code
phone	No	User phone
auto_number	No	License plate number
page	No	The page number of the search results to display
count	No	Number of users on one page
timeout	No	Timeout
search	No	Sequence of characters to search

Example of a request for a list of users who have the character sequence "123" in any of their parameters:

GET http://12:12@172.19.2.236:8085/web2/secure/persons?search=123

Example of a request for a list of users whose patronymic contains "im" and whose phone number contains the sequence "66688":

GET http://22:22@172.19.2.236:8085/web2/secure/persons?phone=6668&patronymic=im

Example of a request for page 15 of the user list:

GET http://228:228@172.19.2.163:8085/web2/secure/persons?page=15

Example of a request for a list of all users of the System:

GET http://127.0.0.1:8085/web2/secure/persons

Response example:

{
    "person":
    {
       "external_id": "",
       "auto_pass_type": "",        
       "levels_times": "",
       "expired": "",
       "marketing_info": "", 
       "card_date": "",
       "who_level": "",
       "visit_purpose": "",
       "level2_id": "",
       "card": "",
       "img" : "", 
       "objname": "",
       "email": "",
       "area_id": "",
       "who_card": "",
       "surname": "",        
       "facility_code": "",         
       "card_loss": "",        
       "auto_brand": "",
       "when_area_id_changed": "",         
       "post": "",        
       "drivers_licence": "",        
       "temp_levels_times": "",        
       "temp_level_id": "",        
       "temp_card": "",        
       "patronymic": "Sergeevich",        
       "location": "",        
       "teleph_work": "",        
       "department": "",       
       "parent_id": "1",        
       "tabnum": "",        
       "pur": "", "",        
       "finished_at": "",        
       "all_param": "",       
       "whence": "",       
       "schedule_id": "",        
       "person": "",       
       "passport": "",        
       "ngp": "",        
       "flags": "",        
       "auto_number": "",        
       "pin": "",       
       "phone": "89782569555",       
       "begin_temp_level": "",        
       "visit_document": "",        
       "visit_birthplace": "",        
       "is_apb": "",        
       "end_temp_level": "",       
       "name": "Petrov",        
       "started_at": "",      
       "level_id": "",       
       "_marker": "",        
       "where_area_id_ap_type": "",        
       "owner_person_id": "",       
       "is_locked": "",        
       "is_active_temp_level": "",        
       "guid": "{C45CAB5F-0560-00A4-A423-D843AE578EE5}",       
       "card_type": "",        
       "begin": "",       
       "where_area_id_ap_id": "",        
       "visit_reg": "",        
       "marketing_info": "",       
       "comment": "",             
       "ad_guid": "",        
       "id": "1"
    }

Page tree

Documentation for Axxon PSIM 1.0.0-1.0.1.