Get Employee Groups

Operation: wsdlGetEmployeeGroups
SOAP Action: uri:FlexForce/wsdlGetEmployeeGroups
Service: FlexForce
Port: FlexForcePort
Style: rpc

Return employee groups (and their members) configured on the unit.

Request

Message: wsdlGetEmployeeGroupsRequest

apiKeystring

API key of the unit.

groupIdint

Group id to filter on. Set to 0 to return all groups.

sharedGroupsboolean

Whether to include groups shared across stores (when the shared setup is in use).

Values

0Ignore groups shared across stores

1Include shared groups

lastModifiedstring

Pass an empty string ("") to ignore this filter, or a date to return only groups modified after that date.

FormatYYYY-MM-DD hh:mm:ss

curl -X POST 'https://api.quinyx.com/FlexForceWebServices.php' \
  -H 'Content-Type: text/xml; charset=utf-8' \
  -H 'SOAPAction: "uri:FlexForce/wsdlGetEmployeeGroups"' \
  --data @- <<'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="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="https://api.quinyx.com/soap/FlexForce">
  <soap:Body>
    <tns:wsdlGetEmployeeGroups>
    <apiKey xsi:type="xsd:string">string</apiKey>
    <groupId xsi:type="xsd:int">0</groupId>
    <sharedGroups xsi:type="xsd:boolean">true</sharedGroups>
    <lastModified xsi:type="xsd:string">string</lastModified>
    </tns:wsdlGetEmployeeGroups>
  </soap:Body>
</soap:Envelope>
EOF

Response

Message: wsdlGetEmployeeGroupsResponse

returnArray<Group>

Array of Group records, each carrying its members array.

itemGroup

An employee group on a unit.

idintrequired

Group primary key.

namestringrequired

Group name.

membersArray<GroupMember>required

Array of GroupMember — the employees who belong to this group.

tsdateTimerequired

Timestamp of the last update, ISO 8601.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="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="https://api.quinyx.com/soap/FlexForce">
  <soap:Body>
    <tns:wsdlGetEmployeeGroupsResponse>
    <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Group[1]">
      <item xsi:type="tns:Group">
        <id xsi:type="xsd:int">0</id>
        <name xsi:type="xsd:string">string</name>
        <members xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:GroupMember[1]">
          <item xsi:type="tns:GroupMember">
            <id xsi:type="xsd:int">0</id>
            <groupId xsi:type="xsd:int">0</groupId>
            <name xsi:type="xsd:string">string</name>
            <employeeId xsi:type="xsd:int">0</employeeId>
            <badgeNo xsi:type="xsd:string">string</badgeNo>
            <ts xsi:type="xsd:dateTime">2024-01-01T00:00:00Z</ts>
          </item>
        </members>
        <ts xsi:type="xsd:dateTime">2024-01-01T00:00:00Z</ts>
      </item>
    </return>
    </tns:wsdlGetEmployeeGroupsResponse>
  </soap:Body>
</soap:Envelope>