Locations

Locations represent the physical places where you deploy Devices.

List Locations of the organization

Retrieve all Locations configured in the organization Role: Location Manager, Organization Manager Scope: organization_read

get

/v1/organizations/{cid}/locations

Authorizations

Path parameters

cidstringrequired

id of the organization (aka tenant)

Query parameters

tagsstring

Filter by a tag or a list of tags comma separated

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://explore.cloud4wi.com//v1/organizations/{cid}/locations' \
  --header 'Authorization: Bearer JWT'

200

default

200

{
  "generated": "text",
  "size": 1,
  "locations": [
    {
      "externalId": "text",
      "id": "text",
      "name": "text",
      "organziationId": "text",
      "lat": 1,
      "lng": 1,
      "timezone": "text",
      "tags": [
        "text"
      ],
      "address": {
        "address": "text",
        "city": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      }
    }
  ]
}

Array with the list of Locations

Get a Location by id

List locations belongs to an organization Scope: organization_read

get

/v1/locations/{lid}

Authorizations

Path parameters

lidstringrequired

Location id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://explore.cloud4wi.com//v1/locations/{lid}' \
  --header 'Authorization: Bearer JWT'

200

default

200

{
  "generated": "text",
  "size": 1,
  "location": {
    "externalId": "text",
    "id": "text",
    "name": "text",
    "organziationId": "text",
    "lat": 1,
    "lng": 1,
    "timezone": "text",
    "tags": [
      "text"
    ],
    "address": {
      "address": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text"
    }
  }
}

Array with the list of Locations

Add a new location

Add a new location Read https://create.cloud4wi.com/dev-hub/api-reference/getting-started/locations for details Role: Organization Manager Scope: organization_write

post

/v1/organizations/{cid}/locations

Authorizations

Path parameters

cidstringrequired

id of the organization (aka tenant)

Body

namestringrequired

loginProfileIdstringrequired

locationProfileIdstringrequired

welcomePortalIdstringrequired

addressstringrequired

citystringrequired

statestringrequired

zipstringrequired

externalIdstring

descriptionstring

enabledboolean

timezonestringrequired

In format "Europe/Rome"

countrystringrequired

country code as ISO 3166-1 alpha-2.

onNetboolean

https://cloud4wi.zendesk.com/hc/en-us/articles/200923267-What-is-the-On-Net-option-for-the-Venue-

categoryNamestring

valid category: other, consumer electronics, sports center, fast food, disco, pools, bar, ice cream, piano bar, underwear, cinema, computers, footwear, gyms, sandwich, sporting goods, hairstyle, public administration, phone, hotels, pizzeria, coffee, restaurants, clothing, pub

organizationPlanIdstring

internet plan id at organization level

tagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://explore.cloud4wi.com//v1/organizations/{cid}/locations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","loginProfileId":"text","locationProfileId":"text","welcomePortalId":"text","address":"text","city":"text","state":"text","zip":"text","timezone":"text","country":"text","tags":[null]}'

200

200

{
  "generated": "text",
  "status": "text",
  "locationId": "text",
  "newTags": [
    "text"
  ]
}

Response

Update a location

Update a location Role: Organization Manager Scope: organization_write

put

/v1/organizations/{cid}/locations/{lid}

Authorizations

Path parameters

cidstringrequired

id of the organization (aka tenant)

lidstringrequired

id of the location

Body

namestring

descriptionstring

externalIdstring

addressstring

citystring

statestring

zipstring

timezonestring

countrystring

country code as ISO 3166-1 alpha-2.

categoryNamestring

valid category: other, consumer electronics, sports center, fast food, disco, pools, bar, ice cream, piano bar, underwear, cinema, computers, footwear, gyms, sandwich, sporting goods, hairstyle, public administration, phone, hotels, pizzeria, coffee, restaurants, clothing, pub

tagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://explore.cloud4wi.com//v1/organizations/{cid}/locations/{lid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"tags":[null]}'

200

200

{
  "generated": "text",
  "status": "text",
  "locationId": "text",
  "newTags": [
    "text"
  ]
}

Response

Delete a location

Delete a location Role: Organization Manager Scope: organization_write

delete

/v1/organizations/{cid}/locations/{lid}

Authorizations

Path parameters

cidstringrequired

id of the organization (aka tenant)

lidstringrequired

id of the location

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://explore.cloud4wi.com//v1/organizations/{cid}/locations/{lid}' \
  --header 'Authorization: Bearer JWT'

200

200

{
  "generated": "text",
  "status": "text"
}

Response

Required input parameters

To use the Create Location API the following parameters are mandatory:

• locationProfileId

• welcomePortalId

• loginProfileId

These parameters can be extracted in the following ways:

locationProfileId

In Cloud4Wi dashboard follow the path:

Manage -> Location Profiles -> *Select the Location Profile of interest

welcomePortalId

In Cloud4Wi dashboard follow the path

Guest WiFi -> Splash Pages -> *Select the Splash Page of interest

loginProfileId

In Cloud4Wi dashboard follow the path

Guest WiFi -> Login Profiles -> *Select the Login Profile of interest

organizationPlanId

In Cloud4wi dashboard follow the path

Guest Wifi -> Internet Plans -> *Select the Internet Plan of interest