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

GEThttps://explore.cloud4wi.com//v1/organizations/{cid}/locations

Path parameters

cid*string

id of the organization (aka tenant)

Query parameters

Response

200default

Array with the list of Locations

Body

application/json

generatedstring

sizenumber

locationsarray of locationListResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://explore.cloud4wi.com//v1/organizations/{cid}/locations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get a Location by id

List locations belongs to an organization Scope: organization_read

GEThttps://explore.cloud4wi.com//v1/locations/{lid}

Path parameters

lid*string

Location id

Response

200default

Array with the list of Locations

Body

application/json

generatedstring

sizenumber

locationlocationListResponse (object)

Request

JavaScriptCurl

const response = await fetch('https://explore.cloud4wi.com//v1/locations/{lid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

POSThttps://explore.cloud4wi.com//v1/organizations/{cid}/locations

Path parameters

cid*string

id of the organization (aka tenant)

Body

application/json

desc

name*string

loginProfileId*string

timezone*string

In format "Europe/Rome"

locationProfileId*string

welcomePortalId*string

country*string

country code as ISO 3166-1 alpha-2.

address*string

city*string

state*string

zip*string

onNetboolean

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

externalIdstring

descriptionstring

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

tagsarray of string

enabledboolean

organizationPlanIdstring

internet plan id at organization level

Response

200

Response

Body

application/json

generatedstring

statusstring

locationIdstring

newTagsarray of string

Request

JavaScriptCurl

const response = await fetch('https://explore.cloud4wi.com//v1/organizations/{cid}/locations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "loginProfileId": "text",
      "timezone": "text",
      "locationProfileId": "text",
      "welcomePortalId": "text",
      "country": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "zip": "text"
    }),
});
const data = await response.json();

Response

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

Update a location

Update a location Role: Organization Manager Scope: organization_write

PUThttps://explore.cloud4wi.com//v1/organizations/{cid}/locations/{lid}

Path parameters

cid*string

id of the organization (aka tenant)

lid*string

id of the location

Body

application/json

desc

namestring

descriptionstring

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

tagsarray of string

externalIdstring

countrystring

country code as ISO 3166-1 alpha-2.

addressstring

citystring

statestring

zipstring

timezonestring

Response

200

Response

Body

application/json

generatedstring

statusstring

locationIdstring

newTagsarray of string

Request

JavaScriptCurl

const response = await fetch('https://explore.cloud4wi.com//v1/organizations/{cid}/locations/{lid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Delete a location

Delete a location Role: Organization Manager Scope: organization_write

DELETEhttps://explore.cloud4wi.com//v1/organizations/{cid}/locations/{lid}

Path parameters

cid*string

id of the organization (aka tenant)

lid*string

id of the location

Response

200

Response

Body

application/json

generatedstring

statusstring

Request

JavaScriptCurl

const response = await fetch('https://explore.cloud4wi.com//v1/organizations/{cid}/locations/{lid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

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