GET api/Group?locationId={locationId}&summaryOnly={summaryOnly}
Get Group List
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId | integer |
Required |
|
| summaryOnly |
Optional paremeter (True by default) to only return original (pre 2022.2.1) summary information |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of Group| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupId | integer |
None. |
|
| LocationId | integer |
None. |
|
| GroupDescription | string |
None. |
|
| GroupName | string |
None. |
|
| ParentGroupId | integer |
None. |
|
| ContactInformation | string |
None. |
|
| UseLocationView | boolean |
None. |
|
| MapImageId | integer |
None. |
|
| FloorPlanImageId | integer |
None. |
|
| SecurityLevel | integer |
None. |
|
| ContactEmail | string |
None. |
|
| CustomTabList | Collection of CustomTab |
None. |
|
| UdfList | Collection of Udf |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"GroupId": 1,
"LocationId": 2,
"GroupDescription": "sample string 3",
"GroupName": "sample string 4",
"ParentGroupId": 5,
"ContactInformation": "sample string 6",
"UseLocationView": true,
"MapImageId": 8,
"FloorPlanImageId": 9,
"SecurityLevel": 10,
"ContactEmail": "sample string 11",
"CustomTabList": [
{
"RequestTabId": 1,
"RequestTabName": "sample string 2",
"RequestTabDescription": "sample string 3",
"IconFile": "sample string 4",
"ImageId": 1,
"ContactEmailAddress": "sample string 5",
"NotifyWhenUtilized": true,
"AdditionalEmailAddress": "sample string 7",
"PageHeader": "sample string 8",
"PageFooter": "sample string 9",
"CustomTabType": 10,
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
]
},
{
"RequestTabId": 1,
"RequestTabName": "sample string 2",
"RequestTabDescription": "sample string 3",
"IconFile": "sample string 4",
"ImageId": 1,
"ContactEmailAddress": "sample string 5",
"NotifyWhenUtilized": true,
"AdditionalEmailAddress": "sample string 7",
"PageHeader": "sample string 8",
"PageFooter": "sample string 9",
"CustomTabType": 10,
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
]
}
],
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
]
},
{
"GroupId": 1,
"LocationId": 2,
"GroupDescription": "sample string 3",
"GroupName": "sample string 4",
"ParentGroupId": 5,
"ContactInformation": "sample string 6",
"UseLocationView": true,
"MapImageId": 8,
"FloorPlanImageId": 9,
"SecurityLevel": 10,
"ContactEmail": "sample string 11",
"CustomTabList": [
{
"RequestTabId": 1,
"RequestTabName": "sample string 2",
"RequestTabDescription": "sample string 3",
"IconFile": "sample string 4",
"ImageId": 1,
"ContactEmailAddress": "sample string 5",
"NotifyWhenUtilized": true,
"AdditionalEmailAddress": "sample string 7",
"PageHeader": "sample string 8",
"PageFooter": "sample string 9",
"CustomTabType": 10,
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
]
},
{
"RequestTabId": 1,
"RequestTabName": "sample string 2",
"RequestTabDescription": "sample string 3",
"IconFile": "sample string 4",
"ImageId": 1,
"ContactEmailAddress": "sample string 5",
"NotifyWhenUtilized": true,
"AdditionalEmailAddress": "sample string 7",
"PageHeader": "sample string 8",
"PageFooter": "sample string 9",
"CustomTabType": 10,
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
]
}
],
"UdfList": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"UdfValue": "sample string 4",
"UdfValue2": "sample string 5",
"DefaultQuery": "sample string 6",
"SpecialNotes": "sample string 7",
"InputType": 8,
"DisplayOrder": 9,
"Required": true,
"AdminOnly": true,
"UdfTypeId": 12,
"UdfTypeDescription": "sample string 13",
"ShowOnEvents": true,
"Searchable": true,
"ParentUdfId": 16,
"Type": 17,
"RequestTabId": 18,
"EntryId": 19
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
<Group>
<ContactEmail>sample string 11</ContactEmail>
<ContactInformation>sample string 6</ContactInformation>
<CustomTabList>
<CustomTab>
<AdditionalEmailAddress>sample string 7</AdditionalEmailAddress>
<ContactEmailAddress>sample string 5</ContactEmailAddress>
<CustomTabType>10</CustomTabType>
<IconFile>sample string 4</IconFile>
<ImageId>1</ImageId>
<NotifyWhenUtilized>true</NotifyWhenUtilized>
<PageFooter>sample string 9</PageFooter>
<PageHeader>sample string 8</PageHeader>
<RequestTabDescription>sample string 3</RequestTabDescription>
<RequestTabId>1</RequestTabId>
<RequestTabName>sample string 2</RequestTabName>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
</CustomTab>
<CustomTab>
<AdditionalEmailAddress>sample string 7</AdditionalEmailAddress>
<ContactEmailAddress>sample string 5</ContactEmailAddress>
<CustomTabType>10</CustomTabType>
<IconFile>sample string 4</IconFile>
<ImageId>1</ImageId>
<NotifyWhenUtilized>true</NotifyWhenUtilized>
<PageFooter>sample string 9</PageFooter>
<PageHeader>sample string 8</PageHeader>
<RequestTabDescription>sample string 3</RequestTabDescription>
<RequestTabId>1</RequestTabId>
<RequestTabName>sample string 2</RequestTabName>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
</CustomTab>
</CustomTabList>
<FloorPlanImageId>9</FloorPlanImageId>
<GroupDescription>sample string 3</GroupDescription>
<GroupId>1</GroupId>
<GroupName>sample string 4</GroupName>
<LocationId>2</LocationId>
<MapImageId>8</MapImageId>
<ParentGroupId>5</ParentGroupId>
<SecurityLevel>10</SecurityLevel>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
<UseLocationView>true</UseLocationView>
</Group>
<Group>
<ContactEmail>sample string 11</ContactEmail>
<ContactInformation>sample string 6</ContactInformation>
<CustomTabList>
<CustomTab>
<AdditionalEmailAddress>sample string 7</AdditionalEmailAddress>
<ContactEmailAddress>sample string 5</ContactEmailAddress>
<CustomTabType>10</CustomTabType>
<IconFile>sample string 4</IconFile>
<ImageId>1</ImageId>
<NotifyWhenUtilized>true</NotifyWhenUtilized>
<PageFooter>sample string 9</PageFooter>
<PageHeader>sample string 8</PageHeader>
<RequestTabDescription>sample string 3</RequestTabDescription>
<RequestTabId>1</RequestTabId>
<RequestTabName>sample string 2</RequestTabName>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
</CustomTab>
<CustomTab>
<AdditionalEmailAddress>sample string 7</AdditionalEmailAddress>
<ContactEmailAddress>sample string 5</ContactEmailAddress>
<CustomTabType>10</CustomTabType>
<IconFile>sample string 4</IconFile>
<ImageId>1</ImageId>
<NotifyWhenUtilized>true</NotifyWhenUtilized>
<PageFooter>sample string 9</PageFooter>
<PageHeader>sample string 8</PageHeader>
<RequestTabDescription>sample string 3</RequestTabDescription>
<RequestTabId>1</RequestTabId>
<RequestTabName>sample string 2</RequestTabName>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
</CustomTab>
</CustomTabList>
<FloorPlanImageId>9</FloorPlanImageId>
<GroupDescription>sample string 3</GroupDescription>
<GroupId>1</GroupId>
<GroupName>sample string 4</GroupName>
<LocationId>2</LocationId>
<MapImageId>8</MapImageId>
<ParentGroupId>5</ParentGroupId>
<SecurityLevel>10</SecurityLevel>
<UdfList>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
<Udf>
<AdminOnly>true</AdminOnly>
<DefaultQuery>sample string 6</DefaultQuery>
<DisplayOrder>9</DisplayOrder>
<EntryId>19</EntryId>
<Id>1</Id>
<InputType>8</InputType>
<Name>sample string 2</Name>
<ParentUdfId>16</ParentUdfId>
<RequestTabId>18</RequestTabId>
<Required>true</Required>
<Searchable>true</Searchable>
<ShowOnEvents>true</ShowOnEvents>
<SpecialNotes>sample string 7</SpecialNotes>
<Type>17</Type>
<UdfTypeDescription>sample string 13</UdfTypeDescription>
<UdfTypeId>12</UdfTypeId>
<UdfValue>sample string 4</UdfValue>
<UdfValue2>sample string 5</UdfValue2>
<Value>sample string 3</Value>
</Udf>
</UdfList>
<UseLocationView>true</UseLocationView>
</Group>
</ArrayOfGroup>