Get a Group

Retrieve information regarding a specific group in WebEOC Nexus using the GetGroup endpoint.

GetGroup endpoint description
Description	Returns details for a specific group in WebEOC Nexus
URL	/groups/[groupname]
Method	GET
Parameter	groupname
Return Type	WebEOCGroup
Sample JSON Response	Copy Code `{ "assignedIncidents": null, "assignedPositions": [ "CMD EOC Director", "CMD IncidentCommander" ], "comments": " ", "name": "Board - After Action Review (Management)", "organizational": false }`

Review the parameter definitions and examples of how to use the GetGroup endpoint in a JavaScript and C# call.

Parameter

GetGroup endpoint parameter
Variable Name	Type	Description	Required
groupname	String	Name of the WebEOC Nexus group to be retrieved	True (URL)

WebEOCGroup: Custom Objects

The WebEOCGroup, returned when using the GetOperation endpoint, contains several unique, custom objects.

Custom objects members
Member Name	Type	Description
name	String	Name of the WebEOC Nexus group
comments	String	Description of the group
organizational	Boolean	True if the group may have process permissions; False if the group will not have process permissions
assignedPositions	String array	WebEOC positions assigned to the group
assignedIncidents	String array	WebEOC incidents assigned to the group

Examples

JavaScript Call

Copy Code

await fetch(`${baseUrl}/groups/Group A`)
.then((response) => response.json())

C# Call

Copy Code

public async Task<WebEOCGroup> GetGroup()
{
using (var httpClient = new HttpClient(httpClientHandler))
{
var response = await httpClient.GetAsync($"{baseUrl}/groups/Group A");
var data = await response.Content.ReadAsStringAsync(); 
return JsonConvert.DeserializeObject<WebEOCGroup>(data);
}
}

Related Concepts

Related Tasks

Assign a Board to a Group

Get Group Boards

Delete a Board Assignment From a Group

Assign Process Permissions to a Group