Get list of users by infofield

getUsersByInfoField(p_companyID, p_InfoField, p_InfoFieldValue)

 

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_InfoField string Yes The infofield on which we will make the search to retrieve the users (info1, info2, info3, ... info14)
p_InfoFieldValue string No The infofield value on which the search is made. If no value is provided we will retrieve all the users that have the p_InfoField value as empty. If a value is provided we will retrieve all the users that have that value set as p_InfoField

Return values

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

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

Achternaam- lastname, string

Voornaam – firstname, string

FaceTemplates – number of face templates, string

'NO_VALID_INFOFIELD' - the company does not have that infofield.

'NO_USER_ID_FOUND' - No user id found based on the infofield provided.

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.getUsersByInfoField soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<p_companyID xsi:type="xsd:string">^4p;tU0Q+#dEIhTWkuj5FnLD^aKWqVu0</p_companyID>
<p_InfoField xsi:type="xsd:string">info1</p_InfoField>
<p_InfoFieldValue xsi:type="xsd:string">NL123456789B01</p_InfoFieldValue>
</uen:Esws.getUsersByInfoField>
</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/" xmlns:tns="uen:esws">
<SOAP-ENV:Body>
<ns1:Esws.getUsersByInfoFieldResponse xmlns:ns1="uen:esws">
<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:getUsersByInfoFieldObject[22]">
<item xsi:type="tns:getUsersByInfoFieldObject">
<UserId xsi:type="xsd:string">2110</UserId>
<Achternaam xsi:type="xsd:string">Mike</Achternaam>
<Voornaam xsi:type="xsd:string">Doe</Voornaam>
<FaceTemplates xsi:type="xsd:string">0</FaceTemplates>
</item>
<item xsi:type="tns:getUsersByInfoFieldObject">
<UserId xsi:type="xsd:string">2111</UserId>
<Achternaam xsi:type="xsd:string">John</Achternaam>
<Voornaam xsi:type="xsd:string">Doe</Voornaam>
<FaceTemplates xsi:type="xsd:string">1</FaceTemplates>
</item>
</return>
</ns1:Esws.getUsersByInfoFieldResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>