Child pages
  • Locations
Skip to end of metadata
Go to start of metadata

Introduction

NOTE - Page under revision for v2.0.

A location is a physical address that can have devices associated with it. You can assign it coordinates and if there are devices assigned, the location will appear on the Map in Open-AudIT Enterprise.

How Does it Work?

Locations are used to assign devices to and will appear on the map in Open-AudIT Enterprise if they have any devices.

Creating a Location

To make another location go to menu -> Admin -> Locations -> Create Location.

View Location Details

Go to menu -> Admin -> Locations -> List Locations.

You will see a list of available locations. You can view a network by clicking on the it's ID (in green). You can also edit or delete the script (if delete is permitted). You cannot delete the Default Location.

Database Schema

Example Database Entry

Locations are stored in the database in the "locations" table. A typical entry will look as below. 

API / Web Access

You can access the /locations collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.

API Routes

Request Method
ID
Action
Resulting Function
Required Permission
URL Example
Notes
Example Response
GETn collectionlocations::read/locationsReturns a list of locations.locations_collection.json
GETy readlocations::read/locations/{id}Returns a location's details.locations_read.json
PATCHy updatelocations::update/locations/{id}Update an attribute of a locations entry.locations_patch.json
POSTn createlocations::create/locationsInsert a new locations entry.locations_create.json
DELETEy deletelocations::delete/locations/{id}Delete a locations entry.locations_delete.json

Web Application Routes

Request Method
ID
Action
Resulting Function
Required Permission
URL Example
Notes
GETncreatecreate_formlocations::create/locations/createDisplays a standard web form for submission to POST /locations.
GETyupdateupdate_formlocations::update/locations/{id}/updateShow the networks details with the option to update attributes using PATCH to /locations/{id}
GETnimportimport_formlocations::create/locations/importDisplays a standard web form for submission to POST /locations/import.
POSTnimportimportlocations::create/locations/importImport multiple locations using a CSV.

 

 

 

 

 

 

  • No labels