Get list of users

getUsers(p_companyID, p_page, p_locationID, p_userId, p_addTimeToDate)

You can use this endpoint to retrieve a list of users from our software.

Parameters

Name	Type	Required	Description
p_companyID	string	Yes	The security code you have been provided with, string (32)
p_page	integer	No	If not provided, all users will be retrieved from the database. If provided 1 we will retrieve the first 1000 users, if provided 2 we will retrieve the next 1000 users (1001-2000) and so on. A maximum of 1000 users can be retrieved if p_page is set. This is useful in cases a company has so many users we can not send back all of them in 1 single message. The maximum value of the p_page is different for each company (it depends on how many users they have), and it can be retrieved by the function getUsersPageNr()
p_locationID	integer	No	This parameter can be used only for companies of type Branch (for EasySecure companies it will not have any effect). If not provided, all users are returned.
p_userId	integer	No	This parameter can be used to retrieve the details of a single user
p_addTimeToDate	integer	No	This parameter can be used to add the start time and end time to StartDate and ExpireDate. If not provided, just the date will be returned for StartDate and ExpireDate. If provided and > 0, start time and end time will be added to StartDate and ExpireDate

Return values

getUsersObjectArray (array), containing structs (arrays) of getUsersObject with the following keys:

UserId – the Id of the user, string - this field is also used to return possible error message when the case

PIN – PIN value of the user, string

Achternaam- lastname, string

Insertion- gag, string

Voornaam – firstname, string

Admin – if the user is admin 1, if the user is not admin 0, string

Security – possible values: 0 or 1, string

StartDate – starting which day the user is accepted to enroll, datetime formatted string (yyyy-mm-dd hh:ii:ss)

ExpireDate – the last day the user can use EasySecure, datetime formatted string (yyyy-mm-dd hh:ii:ss)

info1, string

info2, string

info3, string

info4, string

info5, string

info6, string

info7, string

info8, string

info9, string

info10, string

info11, string

info12, string

info13, string

info14, string

GroupS – a list of all the group names the user belongs to, string

TemplatesNr, string

HasCard- if a user has card enrolled 1, otherwise it is 0, string

CardId, string

CardCustom, string

Sample

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uen="uen:esws">

<soapenv:Header/>

<soapenv:Body>

<uen:Esws.getUsers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<p_companyID xsi:type="xsd:string">^4p;tU0Q+#dEIhTWkuj5FnLD^aKWqVu0</p_companyID>

<p_page xsi:type="xsd:string">1</p_page>

<p_locationID xsi:type="xsd:string"></p_locationID>

<p_user_id xsi:type="xsd:string">5</p_userId>

<p_addTimeToDate xsi:type="xsd:string">1</p_addTimeToDate>

</uen:Esws.getUsers>

</soapenv:Body>

</soapenv:Envelope>

Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<SOAP-ENV:Body>

<ns1:Esws.getUsersResponse xmlns:ns1="uen:esws">

<Achternaam xsi:type="xsd:string">Gabor</Achternaam>

<GroupS xsi:type="xsd:string">Group 1</GroupS>

</item>

</return>

</ns1:Esws.getUsersResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>