Locations/WLANs
- Santiago Nanclares (Unlicensed)
The following section describes the API methods of the WIFI platform referring to the Locations module, which let you to, for example, obtain all the information related to the Locations or WLANs.
Locations
GET - Get Location
Returns all the Locations to which the user has access. If the ID of a particular Location is indicated in the request, this returns all the information related to that Location.
https://<server-domainname>/rest/<version>/Location/{LocationId} |
j
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationId | Location identifier | String | NO | NULL |
Response
HTTP Code | Result | Response data |
|---|---|---|
200 | Ok | {
"data": [{
   "deviceType": "mikrotik",
   "printFormat": "thermal",
   "cacPhone": null,
   "authServer": 1,
   "paypalAccountId": 1,
   "pmsInterfaceId": null,
   "pmsCharges": 0,
   "facebookConfigId": 1,
   "twitterConfigId": 0,
   "linkedinConfigId": 0,
   "instagramConfigId": 0,
   "smsConfigId": null,
   "ticketHeadline": null,
   "realmId": 66,
   "realm": "XXX",
   "coding": "base32pass",
   "id": "02XXX200",
   "name": "WIFI",
   "properties": {
     "usesPasscode": 0,
     "printTickets": 1
   },
   "grantedModules": null,
   "address": "Calle Valentin Beato 22, 28037 Madrid",
   "latLng": "40.4492616,-3.7114444",
   "timezone": "Europe\/Madrid",
   "woeid": null,
   "currency": "eur",
   "isEnabled": 1,
   "avatar": 480,
   "supportCode": null,
   "owner": "XXX",
   "groups": null
 }]
} |
401 | Unauthorized | Explanation of the error |
WLANs
GETÂ - Get WLANs of Location
Returns all the WLANs of the Location specified by the LocationId parameter.
https://<server-domainname>/rest/<version>/Location/wlan/{LocationId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
QUERY | LocationId | Location identifier | String | YES | |
QUERY | offset | integer | NO | ||
QUERY | limit | integer | NO | ||
QUERY | rows | integer | NO | ||
QUERY | page | integer | NO | ||
QUERY | current_page | integer | NO |
Response
HTTP Code | Result | Response data |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
Locations Groups
GETÂ - Get Location Groups
Returns all the Location groups to which the user has access. If the ID of a specific group is indicated in the request, this returns all the Locations that belong to that group.
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationGroupId | Location identifier | String | NO | NULL |
Response
HTTP Code | Result | Response data |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
If the ID of a particular Location group is sent as parameter, all the Locations included in that group will be obtained.
Response
HTTP Code | Result | Response data |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
Groups of WLANs
GETÂ - Get WLAN Groups
Returns all the WLAN Groups to which the user has access. If the ID of a particular group is indicated, this will return all the WLANs that belong to that group.
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlangroupId | WLAN group identifier | String | NO | NULL |
QUERY | offset | integer | NO | ||
QUERY | limit | integer | NO | ||
QUERY | rows | integer | NO | ||
QUERY | page | integer | NO | ||
QUERY | current_page | integer | NO |
Response
HTTP Code | Result | Response data |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
If the ID of a particular WLAN group is sent as a parameter, all the WLANs included in that group would be obtained.
Response:
HTTP Code | Result | Response data |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
Â