GET api/groups

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of GroupModel

Name	Type	Additional information
ID	integer	None.
GRP_TYPE	string	None.
GROUP_NM	string	None.
CAT_ID	integer	None.
CATEGORY	string	None.
GROUP_SHORT_DESC	string	None.
GROUP_LONG_DESC	string	None.
START_DATE	date	None.
END_DATE	date	None.
IS_ACTIVE_FLG	byte	None.
IS_RECURRING_FLG	byte	None.
RECURRING_FREQUENCY	string	None.
IMG_URL	string	None.
GRP_ADMIN_USER_ID	integer	None.
IS_PARENT_PERMISSION_REQUIRED	byte	None.
ROLE_ID	integer	None.
ROLE_NAME	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "GRP_TYPE": "sample string 2",
    "GROUP_NM": "sample string 3",
    "CAT_ID": 4,
    "CATEGORY": "sample string 5",
    "GROUP_SHORT_DESC": "sample string 6",
    "GROUP_LONG_DESC": "sample string 7",
    "START_DATE": "2026-01-09T13:54:54.3707204+00:00",
    "END_DATE": "2026-01-09T13:54:54.3707204+00:00",
    "IS_ACTIVE_FLG": 64,
    "IS_RECURRING_FLG": 64,
    "RECURRING_FREQUENCY": "sample string 12",
    "IMG_URL": "sample string 13",
    "GRP_ADMIN_USER_ID": 14,
    "IS_PARENT_PERMISSION_REQUIRED": 64,
    "ROLE_ID": 16,
    "ROLE_NAME": "sample string 17"
  },
  {
    "ID": 1,
    "GRP_TYPE": "sample string 2",
    "GROUP_NM": "sample string 3",
    "CAT_ID": 4,
    "CATEGORY": "sample string 5",
    "GROUP_SHORT_DESC": "sample string 6",
    "GROUP_LONG_DESC": "sample string 7",
    "START_DATE": "2026-01-09T13:54:54.3707204+00:00",
    "END_DATE": "2026-01-09T13:54:54.3707204+00:00",
    "IS_ACTIVE_FLG": 64,
    "IS_RECURRING_FLG": 64,
    "RECURRING_FREQUENCY": "sample string 12",
    "IMG_URL": "sample string 13",
    "GRP_ADMIN_USER_ID": 14,
    "IS_PARENT_PERMISSION_REQUIRED": 64,
    "ROLE_ID": 16,
    "ROLE_NAME": "sample string 17"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroupModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/School.Models.DataManagement">
  <GroupModel>
    <CATEGORY>sample string 5</CATEGORY>
    <CAT_ID>4</CAT_ID>
    <END_DATE>2026-01-09T13:54:54.3707204+00:00</END_DATE>
    <GROUP_LONG_DESC>sample string 7</GROUP_LONG_DESC>
    <GROUP_NM>sample string 3</GROUP_NM>
    <GROUP_SHORT_DESC>sample string 6</GROUP_SHORT_DESC>
    <GRP_ADMIN_USER_ID>14</GRP_ADMIN_USER_ID>
    <GRP_TYPE>sample string 2</GRP_TYPE>
    <ID>1</ID>
    <IMG_URL>sample string 13</IMG_URL>
    <IS_ACTIVE_FLG>64</IS_ACTIVE_FLG>
    <IS_PARENT_PERMISSION_REQUIRED>64</IS_PARENT_PERMISSION_REQUIRED>
    <IS_RECURRING_FLG>64</IS_RECURRING_FLG>
    <RECURRING_FREQUENCY>sample string 12</RECURRING_FREQUENCY>
    <ROLE_ID>16</ROLE_ID>
    <ROLE_NAME>sample string 17</ROLE_NAME>
    <START_DATE>2026-01-09T13:54:54.3707204+00:00</START_DATE>
  </GroupModel>
  <GroupModel>
    <CATEGORY>sample string 5</CATEGORY>
    <CAT_ID>4</CAT_ID>
    <END_DATE>2026-01-09T13:54:54.3707204+00:00</END_DATE>
    <GROUP_LONG_DESC>sample string 7</GROUP_LONG_DESC>
    <GROUP_NM>sample string 3</GROUP_NM>
    <GROUP_SHORT_DESC>sample string 6</GROUP_SHORT_DESC>
    <GRP_ADMIN_USER_ID>14</GRP_ADMIN_USER_ID>
    <GRP_TYPE>sample string 2</GRP_TYPE>
    <ID>1</ID>
    <IMG_URL>sample string 13</IMG_URL>
    <IS_ACTIVE_FLG>64</IS_ACTIVE_FLG>
    <IS_PARENT_PERMISSION_REQUIRED>64</IS_PARENT_PERMISSION_REQUIRED>
    <IS_RECURRING_FLG>64</IS_RECURRING_FLG>
    <RECURRING_FREQUENCY>sample string 12</RECURRING_FREQUENCY>
    <ROLE_ID>16</ROLE_ID>
    <ROLE_NAME>sample string 17</ROLE_NAME>
    <START_DATE>2026-01-09T13:54:54.3707204+00:00</START_DATE>
  </GroupModel>
</ArrayOfGroupModel>