GET api/groups/{groupId}/sites

Retreives all sites for a group.

Request Information

URI Parameters

Name	Description	Type	Additional information
groupId	The group identifier.	integer	Required
ActiveAlarmCount	If the site is active, the number of active alarms on the site	integer	Read-only
AlarmActive	True if the site is active and there is an active alarm on the site. False if all the site's alarms are inactive Null if there were never any alarms on the site.	boolean	Read-only
Name		string	Invalid Chars: .!@#$%^&*\\|`~=+/?<>()[]," Leading or trailing white spaces are not allowed Max length: 30
UserField1		string	Max length: 255
UserField2		string	Max length: 255
UserField3		string	Max length: 255
UserField4		string	Max length: 255
UserField5		string	Max length: 255
Notes		string	None.
TimeZoneId		integer	None.
X		string	Max length: 50
Y		string	Max length: 50
Z		string	Max length: 50
Status		string	Max length: 50
TypeName		string	Max length: 50
IsInactive		boolean	None.
_activeAlarmCount		ModelPropertyOfInt32	None.
_alarmActive		ModelPropertyOfNullableOfBoolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SiteViewModel

Name	Description	Type	Additional information
Id	Gets or sets the identifier.	integer	None.
Name	Gets or sets the name.	string	Required Invalid Chars: .!@#$%^&*\\|`~=+/?<>()[]," Leading or trailing white spaces are not allowed Max length: 30
UserField1	Gets or sets the first user defined field.	string	Max length: 255
UserField2	Gets or sets the second user defined field.	string	Max length: 255
UserField3	Gets or sets the third user defined field.	string	Max length: 255
UserField4	Gets or sets the fourth user defined field.	string	Max length: 255
UserField5	Gets or sets the fifth user defined field.	string	Max length: 255
Notes	Gets or sets the notes.	string	None.
TimeZoneId	Gets or sets the time zone identifier.	integer	None.
X	Gets or sets the x-coordinate.	string	Max length: 50
Y	Gets or sets the y-coordinate.	string	Max length: 50
Z	Gets or sets the z-coordinate.	string	Max length: 50
Status	Gets or sets the status.	string	Max length: 50
TypeName	Gets or sets the name of the type.	string	Max length: 50
IsInactive	Gets or sets the inactive state.	boolean	None.
ActiveAlarmCount	If the site is active, the number of active alarms on the site	integer	Read-only
AlarmActive	True if the site is active and there is an active alarm on the site. False if all the site's alarms are inactive Null if there were never any alarms on the site.	boolean	Read-only
GroupIds		Collection of integer	None.
Links	Gets the links.	Collection of LinkModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "userField1": "sample string 3",
    "userField2": "sample string 4",
    "userField3": "sample string 5",
    "userField4": "sample string 6",
    "userField5": "sample string 7",
    "notes": "sample string 8",
    "timeZoneId": 1,
    "x": "sample string 9",
    "y": "sample string 10",
    "z": "sample string 11",
    "status": "sample string 12",
    "typeName": "sample string 13",
    "isInactive": true,
    "activeAlarmCount": 14,
    "alarmActive": true,
    "groupIds": [
      1,
      2
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "userField1": "sample string 3",
    "userField2": "sample string 4",
    "userField3": "sample string 5",
    "userField4": "sample string 6",
    "userField5": "sample string 7",
    "notes": "sample string 8",
    "timeZoneId": 1,
    "x": "sample string 9",
    "y": "sample string 10",
    "z": "sample string 11",
    "status": "sample string 12",
    "typeName": "sample string 13",
    "isInactive": true,
    "activeAlarmCount": 14,
    "alarmActive": true,
    "groupIds": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models">
  <SiteViewModel>
    <ActiveAlarmCount>14</ActiveAlarmCount>
    <AlarmActive>true</AlarmActive>
    <GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </GroupIds>
    <Id>1</Id>
    <IsInactive>true</IsInactive>
    <Name>sample string 2</Name>
    <Notes>sample string 8</Notes>
    <Status>sample string 12</Status>
    <TimeZoneId>1</TimeZoneId>
    <TypeName>sample string 13</TypeName>
    <UserField1>sample string 3</UserField1>
    <UserField2>sample string 4</UserField2>
    <UserField3>sample string 5</UserField3>
    <UserField4>sample string 6</UserField4>
    <UserField5>sample string 7</UserField5>
    <X>sample string 9</X>
    <Y>sample string 10</Y>
    <Z>sample string 11</Z>
  </SiteViewModel>
  <SiteViewModel>
    <ActiveAlarmCount>14</ActiveAlarmCount>
    <AlarmActive>true</AlarmActive>
    <GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </GroupIds>
    <Id>1</Id>
    <IsInactive>true</IsInactive>
    <Name>sample string 2</Name>
    <Notes>sample string 8</Notes>
    <Status>sample string 12</Status>
    <TimeZoneId>1</TimeZoneId>
    <TypeName>sample string 13</TypeName>
    <UserField1>sample string 3</UserField1>
    <UserField2>sample string 4</UserField2>
    <UserField3>sample string 5</UserField3>
    <UserField4>sample string 6</UserField4>
    <UserField5>sample string 7</UserField5>
    <X>sample string 9</X>
    <Y>sample string 10</Y>
    <Z>sample string 11</Z>
  </SiteViewModel>
</ArrayOfSiteViewModel>