Hostspot Locations

The HotspotHostspot Locations API provides access to geographicalphysical location data and geographic information for network hotspots within your organization.hotspots. ThisUse this endpoint enables you to retrieve andlocation details, filter hotspotby geographic criteria, and manage location information, making it essentialmetadata for network management,infrastructure geographical analysis,planning and location-based services.reporting.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The HotspotHostspot Locations API allowsenables you to accessmanage and query location data for your network hotspots. This API is essential for organizations that need to track the geographic distribution of their network infrastructure, generate location-based reports, and maintain accurate records of hotspot deployments.

Key capabilities include:

Location Management: Retrieve comprehensive location data forincluding networkaddresses, hotspots deployed across your infrastructure. This API is designed for network administrators, facility managers,coordinates, and developersorganizational who need to:

Monitor Network Coverage: Track where hotspots are deployed geographically to identify coverage gaps or overlapsdetails AssetGeographic ManagementFiltering: Maintain an inventory of hotspotFilter locations withbased on coordinate dataavailability for mapping and visualizationapplications Location-basedChange AnalyticsTracking: Analyze network usage patterns by geographicalMonitor location updates using timestamp-based filtering for synchronization IntegrationPagination Support: Handle large datasets efficiently with Mappingbuilt-in Services:pagination Export location data to third-party mapping or GIS applicationscontrols

The API providesfollows flexibleRESTful filtering options to help you find specific locations based on modification datesprinciples and coordinatereturns availability.paginated Allresults locationfor optimal performance. Location data includes metadataboth aboutbasic wheninformation records(name, weredescription, laststatus) updated,and makingdetailed itgeographic easydata to(coordinates, synchronizeaddresses, withregional externalinformation) systemsthat orcan trackbe changes over time.

This endpoint supports paginationused for efficientmapping, handling of large datasetsanalytics, and includesinfrastructure filtering capabilities to retrieve only the locations relevant to your specific use case.planning.

---

Endpoints

GET /hostspot_locations/

Description: Retrieves a paginated list of hotspothostspot locations with optionalcomprehensive filtering capabilities.options. This endpoint is essentialthe primary method for obtaining geographical data about your network hotspots, including their coordinates and metadata. Use this endpoint when you need to display hotspots on maps, analyze coverage areas, or synchronizeaccessing location data withand externalsupports systems.various filtering criteria to help you find specific locations or subsets of your location inventory.

Use Cases:

• Generate network coverage mapsreports showing all active hotspot locations across your organization
• ExportSync location data with external mapping or analytics systems using timestamp filtering

Retrieve only locations with GPS coordinates for GISmapping analysisapplications andBuild dashboards showing geographic distribution of network planning Synchronize hotspot coordinates with facility management systems Filter locations that have been updated since a specific date for incremental updatesinfrastructure

Full URL Example:

https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&is_active=true&limit=50&offset=0

Parameters:

Parameter	Type	In	Required	Description
last_change__gte	string	query	No	Filter locations modified on or after the specifiedthis date/time. Accepts ISO format: 2000-01-01, 2000-01-01 00:01:00, or 2000-01-01 00:01:00+00:00
limit	integer	query	No	Number of results to return per page.page Default(default ispagination typicallylimit 20, maximum varies by system configurationapplies)
offset	integer	query	No	The initialStarting index from which to returnfor results for pagination. Use with limit(used for page-by-page navigationpagination)
have_coordinates	boolean	query	No	When set to true, returns only locations thatwith haveboth latitude/latitude and longitude coordinatesvalues definedset

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=25&last_change__gte=2024-01-01"offset=0" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 156,247,
  "next": "https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=25&offset=25",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Downtown Coffee Shop - Main BuildingStreet",
      Lobby""short_name": "downtown-coffee-main",
      "is_active": true,
      "description": "Primary entrancelocation Wi-Fiserving hotspot"the downtown business district with high-capacity WiFi access",
      "latitude"organization_id": 40.7589,"org_12345",
      "longitude"thumbnail": -73.9851,"https://gate.zequenze.com/media/locations/downtown-coffee-thumb.jpg",
      "address": "123 BusinessMain Plaza, New York, NY 10001"Street",
      "building"reference": "MainBuilding Building",A, "floor": "Ground Floor",
      "status"city": "active"San Francisco",
      "coverage_radius"postal_code": 50,"94102",
      "state": "California",
      "region": "Pacific",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T09:30:00Z",
      "last_change": "2024-01-15T14:30:22.123456Z",
      "created_at": "2023-06-12T09:15:00Z",
      "organization_id": 42,
      "device_count": 303-10T14:22:15Z"
    },
    {
      "id": 2,
      "name": "ConferenceUniversity RoomLibrary A"- Tech Campus",
      "short_name": "university-library-tech",
      "is_active": true,
      "description": "MeetingEducational roomhotspot wirelessproviding internet access point"for students and faculty",
      "organization_id": "org_12345",
      "thumbnail": "https://gate.zequenze.com/media/locations/university-lib-thumb.jpg",
      "address": "456 University Ave",
      "reference": "Library Building, 2nd Floor",
      "city": "Palo Alto",
      "postal_code": "94301",
      "state": "California",
      "region": "Pacific",
      "country_code": "US",
      "latitude": 40.7591,"37.4419",
      "longitude": "-73.9849,122.1430",
      "address"created": "123 Business Plaza, New York, NY 10001"2024-01-20T11:15:30Z",
      "building": "Main Building",
      "floor": "2nd Floor",
      "status": "active",
      "coverage_radius": 30,
      "last_change": "2024-01-10T11:22:15.789012Z",
      "created_at": "2023-06-12T09:20:00Z",
      "organization_id": 42,
      "device_count": 1
    },
    {
      "id": 3,
      "name": "Warehouse Loading Dock",
      "description": "Outdoor coverage for loading area",
      "latitude": 40.7585,
      "longitude": -73.9855,
      "address": "125 Business Plaza, New York, NY 10001",
      "building": "Warehouse",
      "floor": null,
      "status": "maintenance",
      "coverage_radius": 75,
      "last_change": "2024-01-08T16:02-28T16:45:33.456789Z",
      "created_at": "2023-08-22T13:10:00Z",
      "organization_id": 42,
      "device_count": 222Z"
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns paginated list of hotspot locations

400 Bad Request - Invalid query parameters (e.g., malformed date format) 401 Unauthorized - Invalid or missing authenticationBearer token 403400 ForbiddenBad Request - InsufficientInvalid permissionsparameter tovalues access(e.g., locationmalformed datadate) 429 Too Many Requests - Rate limit exceeded

---

Common Use Cases

Use Case 1: NetworkBuilding Coveragea MappingLocation Map

Retrieve all hotspot locations with GPS coordinates to display hotspots on an interactive map for network planningmonitoring and coverage analysis.dashboards.

GET https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=100is_active=true

Use Case 2: IncrementalSynchronizing Location Data Synchronization

SyncUse timestamp filtering to sync only locations that have beenrecently modified sincelocations yourwith lastexternal updatesystems, to maintain currentreducing data intransfer externaland systems.processing time.

GET https://gate.zequenze.com/api/v1/hostspot_locations/?last_change__gte=2024-01-15T00:03-01T00:00:00Z

Use Case 3: FacilityGenerating ManagementLocation IntegrationReports

ExportPaginate through all locations to create comprehensive reports showing location datadistribution, for specific buildings or areas to integrate with facility managementstatus, and assetorganizational tracking systems.assignments.

GET https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=50100&offset=0

Use Case 4: MaintenanceLocation-Based PlanningAnalytics

Filter locationsand byretrieve modificationlocation datedata to analyze geographic patterns, identify hotspotscoverage that may need attentiongaps, or haveplan recentnew configurationhotspot changes.deployments.

GET https://gate.zequenze.com/api/v1/hostspot_locations/?last_change__gte=2024-01-01country_code=US&limit=25is_active=true

---

Best Practices

• Use Pagination Efficiently: StartImplement withproper reasonablepagination pageby sizesfollowing (25-50the records)next and adjustprevious basedURLs onin yourresponses application'srather performancethan requirementsmanually calculating offsets
• Filter by Coordinates: When displayingbuilding locationsmapping on maps,applications, always use have_coordinates=true to avoid processing locations without geographicalgeographic data
• Implement Incremental UpdatesSync: Use the last_change__gte parameter with stored timestamps to fetchsync only modified records,locations, improving performance and reducing bandwidth and processing time

Handle Timezone Considerations: When using date filters, ensure your timestamps include timezone information for accurate filtering Cache AppropriatelyLocation Data: Location datainformation typically changes infrequently, making it suitable for caching with reasonableappropriate TTL values ErrorHandle HandlingRate Limits: Implement retryexponential logicbackoff forwhen temporaryreceiving failures429 andresponses, validate date format parameters before making requests Rate Limiting: Respect API rate limits by implementing appropriate delays between requestsespecially when processing large datasets CoordinateValidate ValidationCountry Codes: VerifyUse latitude/longitudethe provided country code enum values arewhen withinfiltering validor rangesprocessing (-90location data to 90ensure forconsistency latitude, -180Monitor Active Status: Always consider the is_active field when displaying locations to 180end forusers longitude) before usingor in mappingoperational applicationsdashboards

---