Skip to end of banner
Go to start of banner

Locations

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Introduction

NOTE - Page under revision for v2.0.

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

CREATE TABLE `locations` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(100) NOT NULL DEFAULT '',
  `org_id` int(10) unsigned NOT NULL DEFAULT '1',
  `type` enum('Airforce','Airport','Ambulance Station','Army','Cloud','Conference Center','Court House','Data Center','Depot','District','Doctors Office','Embassy','Factory','Fire Station','Guard','Head Office','High School','Hospital','Hotel','House','Library','Light House','Marina','Mobile Phone Tower','Motel','Navy','Newsagent','Nursing Home','Observatory','Office','Oil Rig','Police','Power Plant','Power Substation','Prison','Radio Station','Regional','Resort','Retail','School','Security','Stadium','Train Station','Travel Agency','TV Station','University','Warehouse','Workshop') NOT NULL DEFAULT 'Office',
  `room` varchar(100) NOT NULL DEFAULT '',
  `suite` varchar(100) NOT NULL DEFAULT '',
  `level` varchar(100) NOT NULL DEFAULT '',
  `address` varchar(100) NOT NULL DEFAULT '',
  `suburb` varchar(100) NOT NULL DEFAULT '',
  `city` varchar(100) NOT NULL DEFAULT '',
  `district` varchar(100) NOT NULL DEFAULT '',
  `region` varchar(100) NOT NULL DEFAULT '',
  `area` varchar(100) NOT NULL DEFAULT '',
  `state` varchar(100) NOT NULL DEFAULT '',
  `postcode` varchar(10) NOT NULL DEFAULT '',
  `country` varchar(100) NOT NULL DEFAULT '',
  `tags` varchar(250) NOT NULL DEFAULT '',
  `phone` varchar(20) NOT NULL DEFAULT '',
  `picture` varchar(100) NOT NULL DEFAULT '',
  `latitude` float(10,6) NOT NULL,
  `longitude` float(10,6) NOT NULL,
  `geo` varchar(200) NOT NULL DEFAULT '',
  `comments` varchar(100) NOT NULL DEFAULT '',
  `icon` varchar(100) NOT NULL DEFAULT '',
  `edited_by` varchar(200) NOT NULL DEFAULT '',
  `edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

Example Database Entry

Locations are stored in the database in the "locations" 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

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