Customer WiFi networks

FortiPortal contains a record for each WiFi network that is defined for the specified customer site.

Get all customer WiFi networks

Method	URL	Description	Arguments	Outputs
GET	/customers/{cid}/sites/{sid}/wifinetworks	List all WiFi networks for a particular customer	cid, sid	JSON array

Arguments

Parameter	Type	Description
cid	int	Customer ID.
sid	int	Customer Site ID.

Outputs

Parameter	Type	Description
	JSON array	Array of customer WiFi network records. One entry per WiFi network, each record contains a unique network ID. See the Customer Wifi Network Record table.

Get a specific customer WiFi network

Method	URL	Description	Arguments	Outputs
GET	/customers/{cid}/sites/{sid}/wifinetwork/{wifiNetworkId}	List the WiFi network information for a particular network id	cid, sid, wifiNetworkId	customer WiFi network record

Arguments

Parameter	Type	Description
cid	int	Customer ID.
sid	int	Site ID.
wifiNetworkId	int	WiFi network ID

Outputs (customer WiFi network record)

The customer WiFi network record contains the following fields:

Parameter	Type	Description
wifiNetworkId	int	WiFi network ID.
wifiNetworkName	String	Name of the site.
contactName	String	Name of the contact for the site.
contactEmail	String	Email address of the contact.
status	String	Site status (active or inactive).
fpcwFapModels	JSON array	Fortinet APs assigned to the network.

Create a new customer WiFi network

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/sites/{sid}/wifinetworks	Create a new network for a particular customer	See the next table.	wifiNetworkId

Arguments

Parameter	Type	Description
cid	int	Customer ID.
sid	int	Site ID
customer WiFi network fields	JSON payload	See the next table.

Arguments (customer WiFi network fields)

Parameter	Type	Required	Description
wifiNetworkName	String	Y	Name of the network.
contactName	String	Y	Name of the contact for the network.
contactEmail	String	Y	Email address of the contact.
status	String		Network status (active or inactive).
fpcwFapModels	JSON array		Fortinet APs assigned to the network.

Outputs

Parameter	Type	Description
wifiNetworkId	int	ID of the newly created network.

Edit a customer WiFi network

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/sites/{sid}/wifinetwork/{wifiNetworkId}	Edit an existing WiFi network.	See the next table.	none

Arguments

Parameter	Type	Description
cid	int	customer ID
sid	int	site ID
wifiNetworkId	int	WiFi network ID
network fields	JSON payload	See Arguments (customer site fields).

Outputs

None.

Delete a customer WiFi network

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/sites/{sid}/wifinetworks/delete/{wifiNetworkId}	Delete the customer WiFi network.	See the next table	none

Arguments

Parameter	Type	Description
cid	int	Customer ID.
sid	int	Site ID.

Outputs

None.