Get FGate List

• Description

​ Retrieve all FGate groups under the current account, along with FGate-related parameters within each group.

• Request Address: (Choose One)

  URL: [Host Server]/api/client/box/grouped

  URL : [Host Server]/api/client/v2/box/grouped?lite=true

• Parameter Description

  Field	Type	Description
  Host Server	string	See Explanation of terms

• Method

  GET

• Headers

  Field	Type	Description
  Authorization	string	"Bearer " + Access Token obtained from the login interface

• Body

  NULL

• Returned Fields

  The server returns an array of FGate groups. Each element in the array {JSON object type} represents a group, and the return structure is as follows:

  Structure of Group Unit JSON Object

  Field	Type	Description
  id	string	Group ID
  name	string	Group Name
  boxRegs	JSON Array	See below

  Properties of the boxRegs JSON Array Elements:

  Field	Type	Description
  id	string	Registration ID associated with the user account when adding (sharing) the box by the system
  alias	string	FGate alias
  boxUid	string	FGate Id
  owned	Boolean	Whether you are the owner
  shared	Boolean	Whether shared by others
  box	json Object	See below

  Properties of the FGate Object:

  Field	Type	Description
  uid	string	FGate uid
  id	string	FGate id
  boxNo	string	FGate Serial Number
  boxType	int	0: Standard Box; 1: Mini Box; 2,4,7 : Lite Boxes; 5: gateway module
  connectionState	int	(FGate online status) 0: Unknown, 1: Connected, 2: Timeout, 3: Disconnected
  cs	json object	apiBaseUrl: Server which box is connected with; signalrUrl: SignalR address which box pushes data to
  commserver	json object	apiBaseUrl: Server which box is connected with; signalrUrl: SignalR address which box pushes data to
  devicePrimarySource	int	Data source FGate , 0: FBox, 1: Server
  memo	string	Remark
  net	int	0: Unknown, 1: Ethernet, 2: GPRS, 4: WIFI (not supported), 5: 4G
  mode	int	1: Transmitting; 0: Normal
  userPassword	string	FGate password
  currentSessionId	string	Current process ID (Negligible)

• Response Codes

  Code	Description
  401	Access token expired
  404	Interface does not exist, please check the URL
  429	Access the interface so frequently, see 429 Status code
  500	Internal error of interface

• Postman example is as follows: