GET api/Group/AccessibleGroupsByGroupId?locationId={locationId}&onlyEnabled={onlyEnabled}&onlyAccessible={onlyAccessible}

Request Information

URI Parameters

Name	Type	Additional information
locationId	integer	Required
onlyEnabled	boolean	Required
onlyAccessible	boolean	Required

Body Parameters

Group

Name	Type	Additional information
dateCreated	date	None.
GroupTypeId	integer	None.
TillRequired	boolean	None.
NumberOfReceiptsOnDeposit	integer	None.
ExtraReceiptsOnMisc	integer	None.
ExtraReceiptsOnManual	integer	None.
TransactionDelay	integer	None.
TipsPercentage	decimal number	None.
AllowReceiveTips	boolean	None.
CanOperate	boolean	None.
CanSetup	boolean	None.
CanAccessGroups	boolean	None.
PartialMakeChange	boolean	None.
ExtraReceiptsOnPayout	integer	None.
AccessCashRunner	boolean	None.
DefaultToDepartments	boolean	None.
LogoutAfterTransaction	boolean	None.
AccessibleGroups	Collection of GroupAccess	None.
enabled	boolean	None.
id	integer	None.
name	string	None.
displayName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "dateCreated": "2025-12-10T11:57:24.1574684+00:00",
  "GroupTypeId": 2,
  "TillRequired": true,
  "NumberOfReceiptsOnDeposit": 4,
  "ExtraReceiptsOnMisc": 5,
  "ExtraReceiptsOnManual": 6,
  "TransactionDelay": 7,
  "TipsPercentage": 8.0,
  "AllowReceiveTips": true,
  "CanOperate": true,
  "CanSetup": true,
  "CanAccessGroups": true,
  "PartialMakeChange": true,
  "ExtraReceiptsOnPayout": 14,
  "AccessCashRunner": true,
  "DefaultToDepartments": true,
  "LogoutAfterTransaction": true,
  "AccessibleGroups": null,
  "enabled": true,
  "id": 19,
  "name": "sample string 20",
  "displayName": "sample string 21"
}

application/xml, text/xml

Sample:

<Group xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models.MIMOCore">
  <displayName xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 21</displayName>
  <enabled xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">true</enabled>
  <id xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">19</id>
  <name xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 20</name>
  <AccessCashRunner>true</AccessCashRunner>
  <AccessibleGroups i:nil="true" />
  <AllowReceiveTips>true</AllowReceiveTips>
  <CanAccessGroups>true</CanAccessGroups>
  <CanOperate>true</CanOperate>
  <CanSetup>true</CanSetup>
  <DefaultToDepartments>true</DefaultToDepartments>
  <ExtraReceiptsOnManual>6</ExtraReceiptsOnManual>
  <ExtraReceiptsOnMisc>5</ExtraReceiptsOnMisc>
  <ExtraReceiptsOnPayout>14</ExtraReceiptsOnPayout>
  <GroupTypeId>2</GroupTypeId>
  <LogoutAfterTransaction>true</LogoutAfterTransaction>
  <NumberOfReceiptsOnDeposit>4</NumberOfReceiptsOnDeposit>
  <PartialMakeChange>true</PartialMakeChange>
  <TillRequired>true</TillRequired>
  <TipsPercentage>8</TipsPercentage>
  <TransactionDelay>7</TransactionDelay>
  <dateCreated>2025-12-10T11:57:24.1574684+00:00</dateCreated>
</Group>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Group'.

Response Information

Resource Description

Collection of Group

Name	Type	Additional information
dateCreated	date	None.
GroupTypeId	integer	None.
TillRequired	boolean	None.
NumberOfReceiptsOnDeposit	integer	None.
ExtraReceiptsOnMisc	integer	None.
ExtraReceiptsOnManual	integer	None.
TransactionDelay	integer	None.
TipsPercentage	decimal number	None.
AllowReceiveTips	boolean	None.
CanOperate	boolean	None.
CanSetup	boolean	None.
CanAccessGroups	boolean	None.
PartialMakeChange	boolean	None.
ExtraReceiptsOnPayout	integer	None.
AccessCashRunner	boolean	None.
DefaultToDepartments	boolean	None.
LogoutAfterTransaction	boolean	None.
AccessibleGroups	Collection of GroupAccess	None.
enabled	boolean	None.
id	integer	None.
name	string	None.
displayName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "dateCreated": "2025-12-10T11:57:24.1574684+00:00",
    "GroupTypeId": 2,
    "TillRequired": true,
    "NumberOfReceiptsOnDeposit": 4,
    "ExtraReceiptsOnMisc": 5,
    "ExtraReceiptsOnManual": 6,
    "TransactionDelay": 7,
    "TipsPercentage": 8.0,
    "AllowReceiveTips": true,
    "CanOperate": true,
    "CanSetup": true,
    "CanAccessGroups": true,
    "PartialMakeChange": true,
    "ExtraReceiptsOnPayout": 14,
    "AccessCashRunner": true,
    "DefaultToDepartments": true,
    "LogoutAfterTransaction": true,
    "AccessibleGroups": null,
    "enabled": true,
    "id": 19,
    "name": "sample string 20",
    "displayName": "sample string 21"
  },
  {
    "dateCreated": "2025-12-10T11:57:24.1574684+00:00",
    "GroupTypeId": 2,
    "TillRequired": true,
    "NumberOfReceiptsOnDeposit": 4,
    "ExtraReceiptsOnMisc": 5,
    "ExtraReceiptsOnManual": 6,
    "TransactionDelay": 7,
    "TipsPercentage": 8.0,
    "AllowReceiveTips": true,
    "CanOperate": true,
    "CanSetup": true,
    "CanAccessGroups": true,
    "PartialMakeChange": true,
    "ExtraReceiptsOnPayout": 14,
    "AccessCashRunner": true,
    "DefaultToDepartments": true,
    "LogoutAfterTransaction": true,
    "AccessibleGroups": null,
    "enabled": true,
    "id": 19,
    "name": "sample string 20",
    "displayName": "sample string 21"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models.MIMOCore">
  <Group>
    <displayName xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 21</displayName>
    <enabled xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">true</enabled>
    <id xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">19</id>
    <name xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 20</name>
    <AccessCashRunner>true</AccessCashRunner>
    <AccessibleGroups i:nil="true" />
    <AllowReceiveTips>true</AllowReceiveTips>
    <CanAccessGroups>true</CanAccessGroups>
    <CanOperate>true</CanOperate>
    <CanSetup>true</CanSetup>
    <DefaultToDepartments>true</DefaultToDepartments>
    <ExtraReceiptsOnManual>6</ExtraReceiptsOnManual>
    <ExtraReceiptsOnMisc>5</ExtraReceiptsOnMisc>
    <ExtraReceiptsOnPayout>14</ExtraReceiptsOnPayout>
    <GroupTypeId>2</GroupTypeId>
    <LogoutAfterTransaction>true</LogoutAfterTransaction>
    <NumberOfReceiptsOnDeposit>4</NumberOfReceiptsOnDeposit>
    <PartialMakeChange>true</PartialMakeChange>
    <TillRequired>true</TillRequired>
    <TipsPercentage>8</TipsPercentage>
    <TransactionDelay>7</TransactionDelay>
    <dateCreated>2025-12-10T11:57:24.1574684+00:00</dateCreated>
  </Group>
  <Group>
    <displayName xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 21</displayName>
    <enabled xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">true</enabled>
    <id xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">19</id>
    <name xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 20</name>
    <AccessCashRunner>true</AccessCashRunner>
    <AccessibleGroups i:nil="true" />
    <AllowReceiveTips>true</AllowReceiveTips>
    <CanAccessGroups>true</CanAccessGroups>
    <CanOperate>true</CanOperate>
    <CanSetup>true</CanSetup>
    <DefaultToDepartments>true</DefaultToDepartments>
    <ExtraReceiptsOnManual>6</ExtraReceiptsOnManual>
    <ExtraReceiptsOnMisc>5</ExtraReceiptsOnMisc>
    <ExtraReceiptsOnPayout>14</ExtraReceiptsOnPayout>
    <GroupTypeId>2</GroupTypeId>
    <LogoutAfterTransaction>true</LogoutAfterTransaction>
    <NumberOfReceiptsOnDeposit>4</NumberOfReceiptsOnDeposit>
    <PartialMakeChange>true</PartialMakeChange>
    <TillRequired>true</TillRequired>
    <TipsPercentage>8</TipsPercentage>
    <TransactionDelay>7</TransactionDelay>
    <dateCreated>2025-12-10T11:57:24.1574684+00:00</dateCreated>
  </Group>
</ArrayOfGroup>