Locations

Locations represent the physical places where you deploy Devices.

List Locations of the organization

get

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

Authorizations

Path parameters

cidstringRequired

id of the organization (aka tenant)

Query parameters

tagsstringOptional

Filter by a tag or a list of tags comma separated

Responses

200

Array with the list of Locations

application/json

default

Error

application/json

get

HTTPcURLJavaScriptPython

GET //v1/organizations/{cid}/locations HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*

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

Get a Location by id

get

List locations belongs to an organization Scope: organization_read

Authorizations

Path parameters

lidstringRequired

Location id

Responses

200

Array with the list of Locations

application/json

default

Error

application/json

get

HTTPcURLJavaScriptPython

GET //v1/locations/{lid} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*

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

Add a new location

post

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

Authorizations

Path parameters

cidstringRequired

id of the organization (aka tenant)

Body

namestringRequired

loginProfileIdstringRequired

timezonestringRequired

In format "Europe/Rome"

locationProfileIdstringRequired

welcomePortalIdstringRequired

countrystringRequired

country code as ISO 3166-1 alpha-2.

addressstringRequired

citystringRequired

statestringRequired

zipstringRequired

onNetbooleanOptional

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

externalIdstringOptional

descriptionstringOptional

categoryNamestringOptional

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[]Optional

enabledbooleanOptional

organizationPlanIdstringOptional

internet plan id at organization level

Responses

200

Response

application/json

post

HTTPcURLJavaScriptPython

POST //v1/organizations/{cid}/locations HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "name": "text",
  "loginProfileId": "text",
  "timezone": "text",
  "locationProfileId": "text",
  "welcomePortalId": "text",
  "country": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "onNet": true,
  "externalId": "text",
  "description": "text",
  "categoryName": "text",
  "tags": [
    "text"
  ],
  "enabled": true,
  "organizationPlanId": "text"
}

200

Response

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

Update a location

put

Update a location Role: Organization Manager Scope: organization_write

Authorizations

Path parameters

cidstringRequired

id of the organization (aka tenant)

lidstringRequired

id of the location

Body

namestringOptional

descriptionstringOptional

categoryNamestringOptional

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[]Optional

externalIdstringOptional

countrystringOptional

country code as ISO 3166-1 alpha-2.

addressstringOptional

citystringOptional

statestringOptional

zipstringOptional

timezonestringOptional

Responses

200

Response

application/json

put

HTTPcURLJavaScriptPython

PUT //v1/organizations/{cid}/locations/{lid} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "name": "text",
  "description": "text",
  "categoryName": "text",
  "tags": [
    "text"
  ],
  "externalId": "text",
  "country": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "timezone": "text"
}

200

Response

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

Delete a location

delete

Delete a location Role: Organization Manager Scope: organization_write

Authorizations

Path parameters

cidstringRequired

id of the organization (aka tenant)

lidstringRequired

id of the location

Responses

200

Response

application/json

delete

HTTPcURLJavaScriptPython

DELETE //v1/organizations/{cid}/locations/{lid} HTTP/1.1
Host: explore.cloud4wi.com
Authorization: Bearer JWT
Accept: */*

200

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