Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

 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

Join Paul McClendon, an Opmantek Support Engineer, as he demonstrates how to create locations in Open-AudIT

Widget Connector
width600
urlhttps://www.youtube.com/watch?v=Xzq3JD7BreM
height400

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

Image Added


Image AddedImage Removed

View Location Details

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

Image Removed

You will see a list of

...

Locations. You can view a

...

Location by clicking on the

...

blue view icon. You can also edit or delete

...

You will also see a list of the devices in that particular location.

Image Removed

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

       id: 4
     name: The Cunninghams
     type: House
     room: 
    suite: 
    level: 
  address: 565 North Clinton Drive
   suburb: 
     city: Milwaukee
 district: 
   region: 
     area: 
    state: Wisconsin
 postcode: 4000
  country: America
     tags: 
    phone: 
  picture: 
 latitude: 42.556568
longitude: -88.874382
      geo: 
 comments: 
     icon: 
 group_id: 0

API / Web Access?

your locations.
.
Image Added

Database Schema

The database schema can be found in the application is the user has database::read permission by going to menu: Admin -> Database -> List Tables, then clicking on the details button for the table.


API / Web Access

You can access the

...

collection using the normal Open-AudIT JSON based API. Just like any other collection. Please

...

see The Open-AudIT API documentation for further details.

...

API Routes

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

Web Application Routes

Request Method
ID
Action
Resulting Function
URL Example
Notes
GETncreatecreate_form/locations/createDisplays a standard web form for submission to POST /locations.
GETyupdateupdate_form/locations/{id}/updateShow the networks details with the option to update attributes using PATCH to /locations/{id}

 

 

 

 

 

...