GET v1/Clients/{clientId}/FacilityGroups

Gets all active Facility Groups that match the query, if provided.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client identifier.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

A list.

Collection of FacilityGroupV1

Name	Description	Type	Additional information
FacilityGroupId	The Facility Group id.	integer	None.
FacilityGroupName	The Facility Group Name.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "FacilityGroupId": 1,
    "FacilityGroupName": "sample string 2"
  },
  {
    "FacilityGroupId": 1,
    "FacilityGroupName": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfFacilityGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models">
  <FacilityGroup>
    <FacilityGroupId>1</FacilityGroupId>
    <FacilityGroupName>sample string 2</FacilityGroupName>
  </FacilityGroup>
  <FacilityGroup>
    <FacilityGroupId>1</FacilityGroupId>
    <FacilityGroupName>sample string 2</FacilityGroupName>
  </FacilityGroup>
</ArrayOfFacilityGroup>