Skip to main content

Device App Access Points

Endpoints Summary

Method Path Swagger GET /device_app_access_points/ Swagger ↗

The Device App Access Points API provides endpoints for managingretrieving and retrievingmanaging access pointspoint locations within your organization's devicenetwork management system.infrastructure. This endpointAPI allowsenables you to query access points with filtering capabilitiescapabilities, and paginated results, making it essential for building dashboards, monitoring systems, andmanage location-based deviceservices, managementand applications.integrate physical access point data into your applications for monitoring, reporting, and operational management.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Device App Access Points API iscategory designedfocuses foron managing physical or logical access points within your organization's infrastructure. Access points represent locations,physical entry points, or network nodeslocations where devicesusers can connect to services, authenticate, or be monitored. This API is particularly useful for:

    Facility Management: Track access pointsresources across- multiplesuch buildings, floors, or zones Network Infrastructure: Monitoras Wi-Fi access points, networkentry nodes,gates, kiosks, or service terminals.

    This API enables you to:

      Retrieve comprehensive lists of access points with detailed location and connectivityconfiguration hubsdata Filter Security Systems: Manage entryaccess points by modification dates to sync changes Access geographic and organizational information for each access controlpoint Integrate access point data into monitoring dashboards, mobile applications, or reporting systems

      Access points contain rich metadata including geographic coordinates, organizational details, physical addresses, and monitoring

      operational status. IoTThis Devicemakes Deployment:the OrganizeAPI particularly valuable for facility management, network monitoring, user experience optimization, and locatecompliance devicesreporting scenarios.

      The pagination system allows efficient handling of large access point inventories, while filtering capabilities enable incremental synchronization and targeted queries based on their associated access points

      Each access point contains comprehensive location data including geographical coordinates, address information, and organizational metadata. The API supports filtering by modification date and provides paginated results for efficient data handling in large deployments.

      The endpoints work together to provide a complete view of your accessspecific pointoperational infrastructure, enabling you to build location-aware applications and maintain accurate records of your physical and digital access points.requirements.


      Endpoints

      GET /device_app_access_points/

      Description: Retrieves a paginated list of all access points inwithin your organization. This endpoint isreturns thecomprehensive primaryinformation wayabout each access point including location data, configuration details, and operational status. Use this endpoint to fetchbuild access point inventories, create location-based services, or synchronize access point data andwith supportsexternal filtering by last modification date, making it ideal for synchronization processes and building real-time dashboards.systems.

      Use Cases:

      • Building a facility managementreal-time dashboard showing all active access points across facilities
      • Synchronizing access point data with external monitoring or management systems
      • Creating location-basedmobile applications that help users locate nearby access points
      Generating compliance reports that include physical location and analytics Monitoring access point statusdetails acrossImplementing yourlocation-based organizationuser authentication or service routing

      Full URL Example:

      https://gate.zequenze.com/api/v1/device_app_access_points/?limit=5025&offset=0&last_change__gte=2024-01-01T00:00:00Z
      

      Parameters:

      Parameter Type In Required Description
      last_change__gte string query No Filter results to only include access points modified on or after this date/time (ISO 8601 format). Useful for incremental synchronization.
      limit integer query No Number of results to return per pagepage. (defaultDefault paginationand appliesmaximum ifvalues notdepend specified)on server configuration.
      offset integer query No The initial index from which to return resultsresults. (usedUse with limit for pagination)pagination.

      cURL Example:

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

      Example Response:

      {
        "count": 156,
        "next": "https://gate.zequenze.com/api/v1/device_app_access_points/?limit=25&offset=25",
        "previous": null,
        "results": [
          {
            "id": 1,1001,
            "name": "Main Building Lobby WiFi"WiFi Access Point",
            "short_name": "main-lobby-wifi"ap",
            "is_active": true,
            "description": "Primary WiFiwireless access point forserving the main building lobby areaand withreception high-speed internet access"area",
            "organization_id": "org_12345",
            "thumbnail": "https://gate.zequenze.com/media/thumbnails/access_point_1.access_points/ap_1001.jpg",
            "address": "123 BusinessCorporate Park Drive"Boulevard",
            "reference": "AP-001-LOBBY"Building A - Level 1 - Sector 3",
            "city": "San Francisco",
            "postal_code": "94105",
            "state": "California", 
            "region": "West Coast",
            "country_code": "US",
            "latitude": "37.7749",
            "longitude": "-122.4194",
            "created": "2024-01-10T08:15T09:30:00Z",
            "last_change": "2024-01-20T14:45:00Z"02-10T14:22:30Z"
          },
          {
            "id": 2,1002,
            "name": "Conference Room AlphaB Access Point"Terminal",
            "short_name": "conf-alpha-ap"room-b-terminal",
            "is_active": true,
            "description": "DedicatedSecure access pointterminal for Conference Room AlphaB supportingwith upintegrated to 50 concurrent devices"authentication",
            "organization_id": "org_12345",
            "thumbnail": "https://gate.zequenze.com/media/thumbnails/access_point_2.access_points/ap_1002.jpg",
            "address": "123 BusinessCorporate Park Drive"Boulevard",
            "reference": "AP-002-CONF-A"Building A - Level 2 - Room B201",
            "city": "San Francisco",
            "postal_code": "94105",
            "state": "California",
            "region": "West Coast", 
            "country_code": "US",
            "latitude": "37.7749"7751",
            "longitude": "-122.4194"4192",
            "created": "2024-01-12T10:15:20T11:45:00Z",
            "last_change": "2024-01-18T16:20:00Z"02-08T16:15:45Z"
          }
        ]
      }
      

      Response Codes:

      Status Description
      200 Success - Returns paginated list of access points data
      401 Unauthorized - Invalid or missing APIBearer token
      403 Forbidden - InsufficientToken valid but insufficient permissions tofor accessthis access pointsorganization
      500404 InternalNot Server ErrorFound - Server-sideEndpoint errornot occurredavailable
      422 Unprocessable Entity - Invalid query parameters (e.g., malformed date format)

      Common Use Cases

      Use Case 1: Building a Real-timeTime Access Point Monitoring Dashboard

      FetchBuild a monitoring dashboard that displays all active access points and displaywith their current status, location, and connectionlast informationupdate on a monitoring dashboard.times. Use the is_active fieldpagination to filterefficiently load large numbers of access points and highlightimplement operationalreal-time status.updates by periodically querying with last_change__gte to fetch only recently modified access points.

      Use Case 2: SynchronizingMobile AccessApp PointLocation DataServices

      Develop a mobile application that helps users find nearby access points. Retrieve all access points with geographic coordinates, then use the latitude/longitude data to calculate distances and display the closest available access points to the user's current location.

      Use Case 3: Incremental Data Synchronization

      Synchronize access point data with external systems like network monitoring tools or facility management software. Use the last_change__gte parameter to implement incremental synchronization with external facility management systems,fetch only fetching access points that have been modified since your last sync.

      synchronization,

      Usereducing Casebandwidth 3:and Location-Basedprocessing Device Management

      Combine access point geographical data (latitude/longitude) with address information to create location-aware applications that can route technicians to specific access points or generate service reports by region.overhead.

      Use Case 4: InventoryCompliance and AssetAudit TrackingReporting

      UtilizeGenerate thecompliance referencereports codesthat require detailed location and descriptions to maintain accurate inventory records of network infrastructure, tracking access point deploymentinformation. acrossRetrieve multiplecomprehensive facilitiesaccess point data including addresses, references, and locations.organizational details to create audit trails and compliance documentation.

      Use Case 5: ReportingGeographic andAccess AnalyticsPoint Distribution Analysis

      GenerateAnalyze comprehensivethe reportsgeographic ondistribution of access pointpoints distributionacross usingdifferent regions, cities, or facilities. Use the location data (city, state, andregion, regioncountry_code) fields,to helpinggroup withaccess capacity planningpoints and infrastructuregenerate investmentinsights decisions.about coverage areas and deployment patterns.


      Best Practices

      • Implement Pagination ManagementEfficiently: Always implement proper pagination when dealing with large numbers of access points. Start withUse reasonable pagelimit sizesvalues (25-100 items)items per page) to balance performance and implementuser client-sideexperience. paginationAlways controls.check for the next field to determine if additional pages are available.

      • Use Incremental Synchronization: UseWhen building systems that need to stay synchronized with access point data, use the last_change__gte parameter for efficient data synchronization. Store the timestamp of your last successful sync and use it to fetch only recently modified records.records, reducing API calls and improving performance.

      • Handle Geographic Data HandlingAppropriately: When working with latitudeLatitude and longitude coordinates,values ensureare returned as strings in decimal format. Convert to appropriate numeric types in your application properly handles decimal precision and validatesvalidate coordinate rangescoordinates before using them in mapping applications.or distance calculations.

      • ReferenceCache CodeAccess StandardizationPoint Data: Establish consistent naming conventions for the short_name and reference fields to enable better searching, sorting, and integration with other systems.

      Error Handling: Implement robust error handling for network timeouts and API rate limits. Consider implementing exponential backoff for retry logic when dealing with temporary service unavailability.

      Caching Strategy: Cache accessAccess point data appropriately since this informationconfigurations typically doesn'don't change frequently. UseImplement theappropriate caching strategies with cache invalidation based on last_change timestamps to implementreduce intelligentunnecessary cacheAPI invalidation.calls.

      Monitor Rate Limits: Implement proper error handling for rate limiting scenarios and consider implementing exponential backoff strategies for retrying failed requests.

      Validate Country Codes: The API supports a comprehensive list of ISO country codes including special territories and regions. Ensure your application can handle the full range of possible country_code values when implementing location-based features.