Localizaciones/WLANs
- Pedro Doroshenko
- Santiago Nanclares (Unlicensed)
A continuación se describen los métodos de la API de la plataforma WIFI referentes al módulo de Localizaciones, los cuales permiten por ejemplo obtener toda la información referente a las Localizaciones o las WLANs.
Localizaciones
GET - Get Location
Devuelve todas las localizaciones a las que tiene acceso el usuario. Si se indica el ID de una Localización en particular devuelve toda la información referida a dicha Localización.
https://<server-domainname>/rest/<version>/Localización/{LocalizaciónId} |
jParámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI |
|
GET | LocationId | Identificador de la Localización | String | NO | NULL |
Respuesta
HTTP Code | Resultado | Datos de respuesta |
|---|---|---|
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 | Explicación del error |
WLANs
GET - Get WLANs of Location
Devuelve todas las WLAN de la Localización especificada mediante el parámetro LocationId.
https://<server-domainname>/rest/<version>/Location/wlan/{LocationId} |
Parámetros
TYPE | Parametro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI |
|
QUERY | LocationId | Identificador de la Localización | String | SI |
|
QUERY | offset |
| integer | NO |
|
QUERY | limit |
| integer | NO |
|
QUERY | rows |
| integer | NO |
|
QUERY | page |
| integer | NO |
|
QUERY | current_page |
| integer | NO |
|
Respuesta
HTTP Code | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
Grupos de Localizaciones
GET - Get Location Groups
Devuelve todos los grupos de Localizaciones a las que el usuario tiene acceso. Si se indica el ID de un grupo en concreto devuelve todos las Localizaciones pertenecientes a dicho grupo.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI |
|
GET | LocationGroupId | Identificador del grupo de Localizaciones | String | NO | NULL |
Respuesta
HTTP Code | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
Si se envía como parámetro el ID de un grupo de Localizaciones en particular se obtendrían todas las Localizaciones incluidas en dicho grupo.
Respuesta
HTTP Code | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
Grupos de WLANs
GET - Get WLAN Groups
Devuelve todos los grupos de WLAN a los que el usuario tiene acceso. Si se indica el ID de un grupo en particular devuelve todas las WLAN que se encuentran dentro de dicho grupo.
Parámetros
TYPE | Parametro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI |
|
GET | wlangroupId | Identificador del grupo de WLAN | String | NO | NULL |
QUERY | offset |
| integer | NO |
|
QUERY | limit |
| integer | NO |
|
QUERY | rows |
| integer | NO |
|
QUERY | page |
| integer | NO |
|
QUERY | current_page |
| integer | NO |
|
Respuesta
HTTP Code | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
Si se envía como parámetro el ID de un grupo de WLANs en particular se obtendrían todas las WLANs incluidas en dicho grupo.
Respuesta
HTTP Code | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |