Customer sites provisioning

FortiPortal contains a record for each site that is defined for a customer.

Get all customer sites

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

Arguments

Parameter	Type	Description
cid	int	Customer ID.

Outputs

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

Get a specific customer site

Method	URL	Description	Arguments	Outputs
GET	/customers/{cid}/sites/{sid}	List the user information for a particular site id	cid, sid	customer site record

Arguments

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

Outputs (customer site record)

The customer site record contains the following fields:

Parameter	Type	Description
networkId	int	Site ID.
networkName	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)
fpcDeviceModels	JSONArray	Devices assigned to the site

Create a new customer site

The network name must be 45 or fewer characters. The system does not support more than 45 characters for a network name.

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

Arguments

Parameter	Type	Description
cid	int	Customer ID.
customer site fields	JSON payload	See the next table.

Arguments (customer site fields)

Parameter	Type	Required	Description
networkName	String	Y	Name of the network. NOTE: The network name must be 45 or fewer characters. The system does not support more than 45 characters for a network name.
contactName	String	Y	Name of the contact for the site.
contactEmail	String	Y	Email address of the contact.
status	String		Site status (active or inactive)
fpcDeviceModels	JSON array		Devices assigned to the site

Outputs

Parameter	Type	Description
sid	int	ID of the newly created site.

Edit a customer site record

The name of a customer site must be 45 or fewer characters. The system does not support more than 45 characters for a customer site name.

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

Arguments

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

Delete a customer site

Method	URL	Description	Arguments	Outputs
POST	/customers/{cid}/sites/delete/{sid}	Delete the customer site.	none	none

Arguments

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

No outputs.