UserGroups Test
ReferenceData/UserGroups?filter={filter}&maintenanceMode={maintenanceMode}
Get all User Groups. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/UserGroups?filter={filter}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
filter string N Filter by user access.
maintenanceMode string N Ignore control grouping.

Request Body

None.
No request body.

Response object type : Collection of UserGroup

Response object type Collection of UserGroup has the following properties.
Property Name Data Type Length Required Readonly Notes
AllowAnalytics boolean
AllowApp boolean
AllowOnTheGo boolean
AllowTablet boolean
CreatedBy string
CreatedDateTime date
CreateLocation string
Description string
Division Division
Id string
IsAdmin boolean
Name string
UpdatedBy string
UpdatedDateTime date 
[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsAdmin": true,
    "AllowApp": true,
    "AllowTablet": true,
    "AllowOnTheGo": true,
    "AllowAnalytics": true,
    "Division": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Organization": {
        "Id": 1,
        "Description": "sample string 1",
        "LicenseeAccountCode": "sample string 2"
      }
    },
    "CreatedDateTime": "2025-04-24T03:56:28.7024109-07:00",
    "CreateLocation": "sample string 9",
    "CreatedBy": "sample string 10",
    "UpdatedDateTime": "2025-04-24T03:56:28.7024109-07:00",
    "UpdatedBy": "sample string 11"
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsAdmin": true,
    "AllowApp": true,
    "AllowTablet": true,
    "AllowOnTheGo": true,
    "AllowAnalytics": true,
    "Division": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Organization": {
        "Id": 1,
        "Description": "sample string 1",
        "LicenseeAccountCode": "sample string 2"
      }
    },
    "CreatedDateTime": "2025-04-24T03:56:28.7024109-07:00",
    "CreateLocation": "sample string 9",
    "CreatedBy": "sample string 10",
    "UpdatedDateTime": "2025-04-24T03:56:28.7024109-07:00",
    "UpdatedBy": "sample string 11"
  }
]
<UserGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <UserGroup>
    <AllowAnalytics>true</AllowAnalytics>
    <AllowApp>true</AllowApp>
    <AllowOnTheGo>true</AllowOnTheGo>
    <AllowTablet>true</AllowTablet>
    <CreateLocation>sample string 9</CreateLocation>
    <CreatedBy>sample string 10</CreatedBy>
    <CreatedDateTime>2025-04-24T03:56:28.7024109-07:00</CreatedDateTime>
    <Description>sample string 3</Description>
    <Division>
      <Description>sample string 3</Description>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Organization>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <LicenseeAccountCode>sample string 2</LicenseeAccountCode>
      </Organization>
    </Division>
    <Id>sample string 1</Id>
    <IsAdmin>true</IsAdmin>
    <Name>sample string 2</Name>
    <UpdatedBy>sample string 11</UpdatedBy>
    <UpdatedDateTime>2025-04-24T03:56:28.7024109-07:00</UpdatedDateTime>
  </UserGroup>
  <UserGroup>
    <AllowAnalytics>true</AllowAnalytics>
    <AllowApp>true</AllowApp>
    <AllowOnTheGo>true</AllowOnTheGo>
    <AllowTablet>true</AllowTablet>
    <CreateLocation>sample string 9</CreateLocation>
    <CreatedBy>sample string 10</CreatedBy>
    <CreatedDateTime>2025-04-24T03:56:28.7024109-07:00</CreatedDateTime>
    <Description>sample string 3</Description>
    <Division>
      <Description>sample string 3</Description>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Organization>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <LicenseeAccountCode>sample string 2</LicenseeAccountCode>
      </Organization>
    </Division>
    <Id>sample string 1</Id>
    <IsAdmin>true</IsAdmin>
    <Name>sample string 2</Name>
    <UpdatedBy>sample string 11</UpdatedBy>
    <UpdatedDateTime>2025-04-24T03:56:28.7024109-07:00</UpdatedDateTime>
  </UserGroup>
</UserGroups>

No entries in change log for this operation.