Get list of groups

getGroups(p_companyID, p_locationID)

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

Parameters

Name	Type	Required	Description
p_companyID	string	Yes	The security code you have been provided with, string (32)
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 groups are returned.

Return values

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

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

GroupName – the name of the group, 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_locationID xsi:type="xsd:string"></p_locationID>

</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.getGroupsResponse xmlns:ns1="uen:esws">

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

</item>

<GroupName xsi:type="xsd:string">Group 2</GroupName>

</item>

</return>

</ns1:Esws.getGroupsResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>