UserGroups Test
ReferenceData/UserGroups/Summary
Get a summary representation of all user groups.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/UserGroups/Summary

URI Parameters

This resource has no URI (Query) parameters.

Request Body

None.
No request body.

Response object type : Collection of UserGroupSummary

Response object type Collection of UserGroupSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
AllowAnalytics boolean
AllowApp boolean
AllowOnTheGo boolean
AllowTablet boolean
Description string
Division Division
Id string
IsAdmin boolean
Name string 
[
  {
    "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"
      }
    }
  },
  {
    "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"
      }
    }
  }
]
<UserGroupSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <UserGroupSummary>
    <AllowAnalytics>true</AllowAnalytics>
    <AllowApp>true</AllowApp>
    <AllowOnTheGo>true</AllowOnTheGo>
    <AllowTablet>true</AllowTablet>
    <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>
  </UserGroupSummary>
  <UserGroupSummary>
    <AllowAnalytics>true</AllowAnalytics>
    <AllowApp>true</AllowApp>
    <AllowOnTheGo>true</AllowOnTheGo>
    <AllowTablet>true</AllowTablet>
    <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>
  </UserGroupSummary>
</UserGroupSummaries>
Change Version Description Contract Old New
Property Added 15.0.0 AllowAnalytics has been added to UserGroupSummary UserGroupSummary UserGroupSummary.AllowAnalytics
Property Added 15.0.0 AllowApp has been added to UserGroupSummary UserGroupSummary UserGroupSummary.AllowApp
Property Added 15.0.0 AllowOnTheGo has been added to UserGroupSummary UserGroupSummary UserGroupSummary.AllowOnTheGo
Property Added 15.0.0 AllowTablet has been added to UserGroupSummary UserGroupSummary UserGroupSummary.AllowTablet
Property Added 15.0.0 Division has been added to UserGroupSummary UserGroupSummary UserGroupSummary.Division