Retrieve all Locations configured in the organization Role: Location Manager, Organization Manager Scope: organization_read
id of the organization (aka tenant)
Filter by a tag or a list of tags comma separated
Array with the list of Locations
Error
List locations belongs to an organization Scope: organization_read
Location id
Array with the list of Locations
Error
Add a new location Read https://create.cloud4wi.com/dev-hub/api-reference/getting-started/locations for details Role: Organization Manager Scope: organization_write
id of the organization (aka tenant)
In format "Europe/Rome"
country code as ISO 3166-1 alpha-2.
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
internet plan id at organization level
Response
new tags added
Update a location Role: Organization Manager Scope: organization_write
id of the organization (aka tenant)
id of the location
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
country code as ISO 3166-1 alpha-2.
Response
new tags added
Delete a location Role: Organization Manager Scope: organization_write
id of the organization (aka tenant)
id of the location
Response
Response
Response
Response
{
"generated": "text",
"status": "text",
"locationId": "text",
"newTags": [
"text"
]
}{
"generated": "text",
"status": "text",
"locationId": "text",
"newTags": [
"text"
]
}GET /v1/organizations/{cid}/locations HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
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 /v1/locations/{lid} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
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"
]
}
}POST /v1/organizations/{cid}/locations HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}PUT /v1/organizations/{cid}/locations/{lid} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}DELETE /v1/organizations/{cid}/locations/{lid} HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"generated": "text",
"status": "text"
}