Skip to main content

Hostspot Access Points

Endpoints Summary

Method Path Swagger GET /hostspot_access_points/ Swagger ↗

The Hotspot Access Points API provides endpoints for managing and retrieving information about physical network access point locations within your organization. ThisThese APIendpoints allowsallow you to queryfetch detailed location data, filter by geographical coordinates, and manage access point datametadata withfor locationnetwork coordinates,infrastructure filter by activity status,monitoring and retrieve detailed information about each hotspot location including address details and geographical coordinates.reporting.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Hotspot Access Points API isenables designedyou forto managingmanage wirelessand query physical network infrastructureaccess point locations withinacross your organization.organization's infrastructure. This API enablesis essential for network administratorsadministrators, IT teams, and developersfacility managers who need to programmaticallymaintain accurate records of wireless access informationpoint about Wi-Fi hotspots, access points, and their physical locations.deployments.

Key Features:

  • Retrieve comprehensive access point location data including geographical coordinates
  • Filter access points by geographicalmodification coordinatesdates and coordinate availability
  • QueryAccess bydetailed lastaddress modificationinformation timestamps
including Paginatedcity, resultsstate, forpostal largecodes, datasetsand country data Support for location-basedpagination servicesto integrationhandle large deployments efficiently Integration with organizational structures for multi-tenant environments

Common IntegrationUse Scenarios:Cases:

  • Network monitoringinfrastructure dashboardsauditing thatand displaydocumentation
Geographic visualization of access point locationscoverage on mapsareas MobileLocation-based applicationsnetwork thatperformance helpmonitoring techniciansFacility locatemanagement specificand hotspotsspace planning Compliance reporting for maintenance Analytics platforms tracking network coverage across different regions Inventory management systems maintaining records of deployed network equipment Geofencing applications that trigger actions based on proximity to access pointsinfrastructure

The API follows REST conventionsprinciples and returns data in JSON format with standardized responsepagination formats,for makinglist itendpoints. easyAll location data includes metadata such as creation dates and last modification times to integratesupport withchange existing network management toolstracking and customaudit applications.requirements.

Endpoints

GET /hostspot_access_points/

Description: Retrieves a paginated list of all hotspot access points inwithin your organization. This endpoint provides comprehensive informationlocation about each access pointdata including locationgeographical coordinates, address details, status, and geographicalorganizational coordinates.metadata. It's the primary endpoint for accessingdiscovering yourand enumerating network infrastructure data and supports various filtering options to help you find specific access pointspoint or those meeting certain criteria.locations.

Use Cases:

  • DisplayGenerate network infrastructure reports showing all active access pointspoint on a network monitoring dashboardlocations
  • GenerateCreate reportsgeographic visualizations of network coverage across different geographical regions
Identify access points that need coordinate updates for mapping applicationsareas Audit networkaccess infrastructurepoint changesdeployments withinacross amultiple specific time periodfacilities Export access pointlocation data for integration with third-party networkfacility management toolssystems Monitor recent changes to access point configurations

Full URL Example:

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=2550&offset=0

Parameters:

Parameter Type In Required Description
last_change__gte string query No Filter results to show only include access points modified on or after the specified date/time.date. Accepts ISO format dates: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. Use for pagination control. Default and maximum limitsvalues aredepend seton byyour theorganization's serverconfiguration
offset integer query No The startinginitial index forfrom which to return results. Use with limitUsed for pagination (e.g.,through offset=25&limit=25large for page 2)datasets
have_coordinates boolean query No When set to true, returns only returns access points that have both latitude and longitude coordinates configured

cURL Example:

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

Example Response:

{
  "count": 156,127,
  "next": "https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=1025&offset=10"25",
  "previous": null,
  "results": [
    {
      "id": 1001,
      "name": "MainBuilding BuildingA - GroundFirst Floor AP"Lobby",
      "short_name": "main-building-ground-ap"bldg-a-lobby",
      "is_active": true,
      "description": "PrimaryMain entrance lobby access point coveringserving lobbyreception area and receptionvisitor area"seating",
      "organization_id": "org_abc123def456"org-12345",
      "thumbnail": "https://gate.zequenze.com/media/thumbnails/ap_1001_thumb.ap_1001.jpg",
      "address": "123 Business ParkCorporate Drive",
      "reference": "Building A - Suite 100"AP-LOBBY-001",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "WestBay Coast"Area",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T08:30:00Z",
      "last_change": "2024-03-10T14:22:15Z"00Z"
    },
    {
      "id": 1002,
      "name": "Building A - Conference Room WiFi Hub"Alpha",
      "short_name": "conference-room-hub"conf-alpha",
      "is_active": true,
      "description": "High-capacityConference room access point forsupporting conferenceup andto meeting50 rooms"simultaneous connections",
      "organization_id": "org_abc123def456"org-12345",
      "thumbnail": "https://gate.zequenze.com/media/thumbnails/ap_1002_thumb.ap_1002.jpg",
      "address": "123 Business ParkCorporate Drive",
      "reference": "Building A - 2nd Floor Conference Wing"AP-CONF-002",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "WestBay Coast"Area",
      "country_code": "US",
      "latitude": "37.7751",
      "longitude": "-122.4192",
      "created": "2024-01-20T10:15:30Z"15T08:45:00Z",
      "last_change": "2024-02-28T09:45:22Z"28T11:15:00Z"
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns paginated list of access points
401 Unauthorized - Invalid or missing Bearer token
403 Forbidden - Token valid but lacks permission forto access this resourceorganization's data
422 Unprocessable Entity - Invalid query parameter formatparameters (e.g., malformed date)
date 500 Internal Server Error - Server-side error occurredformat)

Common Use Cases

Use Case 1: Network Coverage Mapping

Retrieve all access points with coordinates to displaycreate geographic visualizations of network coverage on an interactive map.coverage. Use the have_coordinates=true parameter to ensure you only get mappable locations,locations are returned, then plot each access point using the latitude and latitude/longitude fields.data on mapping platforms.

Use Case 2: Infrastructure AuditChange and MaintenanceAuditing

QueryMonitor recent modifications to access pointspoint modifiedconfigurations withinby afiltering specific timeframe usingwith last_change__gte to identify recently updated configurations.parameter. This helps track maintenancewhen activitieslocations were updated, moved, or reconfigured for compliance and ensurechange networkmanagement changes are properly documented.purposes.

Use Case 3: MobileFacility TechnicianManagement AppIntegration

BuildExport acomprehensive mobilelocation applicationdata thatincluding helpsfull fieldaddress technicians locate specific access points for maintenance or troubleshooting. Use the address, reference,details and coordinatereference datacodes to provideintegrate turn-by-turnwith navigationfacility tomanagement equipmentsystems. locations.The structured address fields support geocoding and space planning applications.

Use Case 4: NetworkMulti-Location Inventory ManagementReporting

ExportGenerate completeorganization-wide reports by paginating through all access pointpoints dataacross for integration with asset management systems.facilities. Use paginationthe withorganization_id appropriate limit/offset valuesfield to processgroup largeresults datasetsby efficientlybusiness withoutunits overwhelmingor systemgeographic resources.regions.

Use Case 5: RegionalNetwork PerformanceCapacity AnalyticsPlanning

FilterAnalyze access pointspoint by geographical regions using the city, state,distribution and region fieldsdescriptions to generate location-based network performance reports and identify areas needing infrastructureadditional improvements.coverage or capacity upgrades. The is_active field helps distinguish between deployed and decommissioned locations.

Best Practices

  • Pagination Strategy: AlwaysFor large deployments, use reasonable limitpage valuessizes (10-100)25-100 items) and implement proper pagination handling to avoid timeout issues with large datasets. Implement proper pagination logic using the nexttimeouts and previousreduce URLsmemory provided in responses.

    usage

  • Coordinate Filtering: When building mapping applications, always use have_coordinates=true to avoid attemptingprocessing to plot access pointslocations without locationgeographic data, which would cause map rendering errors.

    data

  • Date Filtering: Use ISO 8601 format dates for last_change__gte parameter.parameter Includeefficiently timezoneby informationcaching whenprevious precisionquery istimestamps important:to 2024-03-01T00:00:00+00:00.

    fetch only recently modified access points

  • Caching Considerations: Access point data typically changes infrequently, making it suitable for caching. Consider implementing cache invalidation based on the last_change timestamp.

Error Handling: AlwaysImplement handleretry paginationlogic edgefor cases5xx (empty results, last page)errors and validategraceful coordinatedegradation datafor before4xx usingerrors, itparticularly inwhen mappingprocessing applications.large Some access points may have partial address information.

datasets

Rate Limiting: Monitor response times and implement appropriate delays between requests when batch processing access point data

Security: Never log or expose Bearer tokens in client-side code.code; Usealways handle authentication server-side proxiesin orproduction secureenvironments token refreshCaching: mechanismsConsider forcaching webstable applicationsaccess accessingpoint thisdata API.(locations rarely change) while refreshing dynamic fields like status and last modification dates more frequently
Back to top