Extreme Networks Logo
Documentation Powered by ReDoc

ExtremeLocation Configuration Service APIs (1.0.0)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com

ExtremeLocation Configuration service APIs allow you to programmatically access and manage site, floor, and device (sensor) settings.

ExtremeLocation User Documentation

Geofence Resource

Retrieve Geofence list

List of Geofences.

Responses

200

Successfully retrieved list of geofence details

400

Bad Request

404

Geofences not found

500

Internal Server Error

get /v1/geofences
https://manage.extremelocation.com/eloc-api/configuration/v1/geofences

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create Geofence

Create Geofence for a Site

Request Body schema: application/json

Geofence to be created

string

Responses

200

Geofence created

400

Bad Request

500

Internal Server Error

post /v1/geofences
https://manage.extremelocation.com/eloc-api/configuration/v1/geofences

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "headers":
    {
    },
  • "lastModified": "2019-08-16T20:05:07Z",
  • "date": "2019-08-16T20:05:07Z",
  • "cookies":
    {
    },
  • "status": 0,
  • "statusInfo":
    {
    },
  • "metadata":
    {
    },
  • "stringHeaders":
    {
    },
  • "entity": { },
  • "mediaType":
    {
    },
  • "allowedMethods":
    [
    ],
  • "entityTag":
    {
    },
  • "links":
    [
    ],
  • "length": 0,
  • "language":
    {
    },
  • "location": "http://example.com"
}

Retrieve Geofence details by ID

Details of Geofence.

path Parameters
id
required
string

ID of the Geofence for which the details are to be retrieved.

Responses

200

Successfully retrieved the geofence details

400

Bad Request

404

Geofence not found

500

Internal Server Error

get /v1/geofences/{id}
https://manage.extremelocation.com/eloc-api/configuration/v1/geofences/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "parent": "string",
  • "radius": 0,
  • "vertex":
    {
    },
  • "area": 0,
  • "created": "string",
  • "updated": "string",
  • "tags":
    [
    ],
  • "isActive": false,
  • "isArchived": false,
  • "company": "string"
}

Update Geofence details by ID

Update the Geofence details

path Parameters
id
required
string

ID of the Geofence for which the details are to be updated.

Request Body schema: application/json

Geofence to be updated

string

Responses

200

Geofence updated successfully

400

Bad Request

404

Geofence not found

500

Internal Server Error

put /v1/geofences/{id}
https://manage.extremelocation.com/eloc-api/configuration/v1/geofences/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "headers":
    {
    },
  • "lastModified": "2019-08-16T20:05:07Z",
  • "date": "2019-08-16T20:05:07Z",
  • "cookies":
    {
    },
  • "status": 0,
  • "statusInfo":
    {
    },
  • "metadata":
    {
    },
  • "stringHeaders":
    {
    },
  • "entity": { },
  • "mediaType":
    {
    },
  • "allowedMethods":
    [
    ],
  • "entityTag":
    {
    },
  • "links":
    [
    ],
  • "length": 0,
  • "language":
    {
    },
  • "location": "http://example.com"
}

Delete Geofence

Delete the Geofence

path Parameters
id
required
string

ID of the Geofence for which the details are to be deleted.

Responses

200

Geofence deleted successfully

400

Bad Request

404

Geofence not found to delete

500

Internal Server Error

delete /v1/geofences/{id}
https://manage.extremelocation.com/eloc-api/configuration/v1/geofences/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "headers":
    {
    },
  • "lastModified": "2019-08-16T20:05:07Z",
  • "date": "2019-08-16T20:05:07Z",
  • "cookies":
    {
    },
  • "status": 0,
  • "statusInfo":
    {
    },
  • "metadata":
    {
    },
  • "stringHeaders":
    {
    },
  • "entity": { },
  • "mediaType":
    {
    },
  • "allowedMethods":
    [
    ],
  • "entityTag":
    {
    },
  • "links":
    [
    ],
  • "length": 0,
  • "language":
    {
    },
  • "location": "http://example.com"
}

Floors Resource

Retrieve floor for given site

Retrieve list of floors for a specific site.

query Parameters
parent
required
string

ID of the parent i.e, Site ID.

Responses

200

Floor list retrieved successfully

400

Page not found

404

Error retriving floor list

get /v1/floors
https://manage.extremelocation.com/eloc-api/configuration/v1/floors

Create floor for site

This API helps to create a floor in a Site. The floorplan image of the floor can be uploaded using this API. The details for which the floor needs to be added must be provided as part of the request.
* the required parameters are as follows.
* name : Represents the site name.
* floorName : Represents the name of the floor.
* floorImg : Represents the image of the floor.
* clientId : Represents the macId of the client.
* ceilingHeight : Represents the ceiling height of the floor.
* floorScale : Represents the scale of the floor.

Request Body schema: multipart/form-data

ID of the client that sent the request.

Array
contentDisposition
object (ContentDisposition)
entity
object
headers
object
mediaType
object (MediaType)
messageBodyWorkers
object (MessageBodyWorkers)
parent
object (MultiPart)
providers
object (Providers)
simple
boolean
Default: false
formDataContentDisposition
object (FormDataContentDisposition)
name
string
value
string
parameterizedHeaders
object

Responses

200

Floor created successfully for site

400

Bad Request

404

Error creating floor

post /v1/floors
https://manage.extremelocation.com/eloc-api/configuration/v1/floors

Update floor details.

This API updates the details of the floor. The metadata like ceiling height, regions on the floor etc can be updated using this API.
the required parameters are as follows.
id : Represents the floor identifier.
nodeType : Represents the nodeType whether device,floor or site. Here it is floor.
parent : Represents the parent for the floor. Here it is site..
regions : Represents the list of regions for the floor.

path Parameters
id
required
string

ID of the floor for which the details are to be updated.

Request Body schema: application/json

JSON object containing all the floor information.

string

Responses

200

Floor details updated successfully

400

Bad Request

404

Error updating floor details

put /v1/floors/{id}
https://manage.extremelocation.com/eloc-api/configuration/v1/floors/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Delete floor details.

This API deletes the floor from a Site. The entire data related to the floor like analytics, metadata will be removed from the DB.
* The required parametrs are as follows.
* clientId : Represents the macId of the client.
id : Represents the floor identifier.
parent : Represents the parent for the floor. Here it is site..
nodeType : Represents the nodeType, whether it is device, floor or site. Here the nodeType is floor.

path Parameters
id
required
string

ID of the floor for which the details are to be deleted.

Request Body schema: application/json

JSON object containing all the floor information.

string

Responses

200