API docs by Redocly

VAULT API (3.0.0)

Download OpenAPI specification:

VAULT API Support: support@roamingiq.com License: Commercial License Terms of Service
Complete API Documentation & Integration Guide

VAULT WiFi Authentication & Management Platform API

VAULT is an enterprise WiFi authentication, subscriber management, and monetization platform that provides comprehensive APIs for network operators, venue administrators, and subscribers. The platform integrates with property management systems, payment processors, and network infrastructure to deliver seamless WiFi services.

Platform Architecture

The VAULT API consists of three main console interfaces:

Subscriber Console

Self-service portal for WiFi subscribers and guests

Core Functions:

  • Authentication via email, phone, or token-based login
  • Device key management and WiFi credential provisioning
  • Subscription management and payment processing
  • Support ticket creation and account maintenance

Venue Management Console

Administrative interface for property and venue managers

Core Functions:

  • Venue configuration and building/unit management
  • Subscriber administration and billing oversight
  • Staff access control and permissions management
  • Usage analytics and support ticket management

Network Operator Console

Enterprise management for network service providers

Core Functions:

  • Multi-venue network operations and equipment management
  • Subscriber provisioning and service plan configuration
  • Administrative tools and system-wide monitoring

Technical Architecture

Backend Infrastructure: - AWS Lambda serverless functions for API endpoint handlers - AWS Cognito Identity Provider for authentication and user management - Distributed data storage for relationship and metadata management

Payment Processing: - Stripe integration for subscription billing and payment management - Automated billing cycles with failure handling and retry logic - Support for multiple currencies and regional payment methods

Network Integration: - ConnectWise API integration for network equipment management - PRTG monitoring system integration for real-time equipment status - RADIUS authentication support for WiFi infrastructure - Device bandwidth monitoring and usage analytics - Supported gateways: Nomadix, Mikrotik, Peplink

Security & Compliance: - Multi-level access controls with role-based permissions - Input validation and sanitization on all endpoints - Audit logging for compliance and security monitoring - GDPR-compliant data handling and privacy protection

👨‍💼 Staff & Support Operations (/staff/, /support/):

  • 🔐 Granular staff access control with role-based permissions
  • 🎫 Integrated ticketing system for subscriber support and issue resolution
  • 🔍 Administrative oversight tools for venue operations and compliance

Endpoint Categories

Venue Management Console

Venue Operations: - Multi-building property discovery and configuration management - Real-time network equipment monitoring with ConnectWise integration - Usage analytics and bandwidth reporting with timezone support - RSSI signal strength monitoring and network optimization - Operational history and audit logging

Subscriber Management: - Complete subscriber lifecycle from onboarding to billing - Payment processing with Stripe integration and transaction history - Subscription modifications including plan changes and pricing adjustments - Communication tools and notification systems - Email validation and PII data management

Unit-Level Management: - Individual unit usage tracking and bandwidth monitoring - WiFi key pool management for secure device authentication - Unit-specific audit logs and activity tracking

Subscriber Console

Authentication & Profile Management: - Multi-modal login support (email, phone, subscriber tokens) - Terms & Conditions acceptance workflow and compliance tracking - Password reset and account recovery with secure validation - Personal information updates with privacy controls

Device & Access Management: - WiFi key generation and device registration - Real-time device session monitoring and connection history - Device naming and tagging for user organization - Key lifecycle management including rotation and security updates

Subscription & Billing: - Self-service subscription management and plan modifications - Payment method management with Stripe integration - Subscription cancellation with automated processing - Transaction history and billing statement access

Support & Communication: - Self-service ticketing system with automated routing - Venue communication and message acknowledgment - Account activity logging for transparency - Multi-language support (English, Spanish)

API Design Standards

Architecture: - OpenAPI 3.0.3 specification with comprehensive schema validation - RESTful design using POST methods with JSON payloads - Token-based authentication via AccessToken parameters - Standardized response format with consistent error handling

Security Framework: - TLS encryption with AWS Certificate Manager - AWS Cognito Identity Provider for authentication - Role-based access controls with venue-level isolation - Input validation and sanitization on all endpoints - Audit logging with immutable records and user attribution

Infrastructure Architecture infrastructure with distributed data storage

  • ⚡ High-Performance Caching: Intelligent caching layer for usage statistics and session management optimization
  • 🔌 External Integrations: ConnectWise for equipment management, PRTG for network monitoring
  • 💳 Payment Processing: Secure gateway integration with refund and chargeback handling
  • 🕸️ Relationship Database: Advanced relationship modeling for venue-subscriber hierarchies

📖 Implementation Guide

🔐 Authentication Flow

All API endpoints require authentication via AccessToken in the JSON request body:

Cloud Services: - AWS Lambda serverless functions for scalable API processing - AWS Cognito Identity Provider for secure user authentication - Distributed data storage for scalable relationship management

External Integrations: - Stripe payment processing for subscription billing and transactions - ConnectWise API for network equipment management and configuration - PRTG monitoring system for real-time infrastructure status - SMTP services for automated email communications - Supported network gateways: Nomadix, Mikrotik, Peplink

Request/Response Format

Standard Request Structure: json { "AccessToken": "authentication_token", "VenueID": "venue_identifier", "RequestParameters": "endpoint_specific_data" }

Standard Response Structure: json { "message": "Operation result description", "errorProcessing": false, "data": "endpoint_specific_results", "SupportedLocales": { "en-us": "English (US)", "es-xl": "Spanish (Latin America)" } }

Error Response Format: - HTTP Status Codes: 200 (Success), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 500 (Server Error) - Localized error messages with troubleshooting guidance - Rate limiting with 429 responses and retry-after headers - Service maintenance notifications with 503 responses

My Account

👤 My Account Self-Service Portal

Comprehensive self-service portal for subscribers to manage their account, services, billing, and preferences independently.

Account Management

  • 📋 Profile Management: Personal information, contact details, and preferences
  • 💳 Billing & Payments: View invoices, make payments, manage payment methods
  • 📊 Service Overview: Current plan details, usage statistics, and service status
  • 📱 Communication Preferences: Notification settings, contact preferences, and alerts
  • 🔒 Security Settings: Password changes, MFA setup, and security preferences
  • 📈 Usage Analytics: Bandwidth consumption, session history, and activity reports

Self-Service Features

  • 🔄 Plan Changes: Upgrade, downgrade, or modify service plans
  • 💬 Support Access: Submit tickets, chat support, and help resources
  • 📋 Document Access: Contracts, invoices, and account documentation
  • 🏠 Unit Management: Move requests and unit change processing

/subscriberconsole/login

Authenticate using email/password, phone/password, subscriber token, or SSO token with AWS Cognito integration.

Authentication Methods:

  • Email + Password - Standard authentication
  • Phone + Password - E.164 format phone numbers
  • Subscriber Token + Password - Legacy token authentication
  • SSO JWT - Pre-authenticated token validation

Features:

  • Multi-tenant operator pools with Cognito user pools
  • Distributed session management for scalable authentication
  • Token refresh support with automatic renewal
  • Localized error messages for global deployments
Authorizations:
None
Request Body schema: application/json
required
One of
EmailAddress
required
string <email>

Subscriber email address for authentication - mapped to Cognito username via operator-specific lookup

PhoneNumber
string^[\+]?[1-9][\d]{0,15}$

Phone number in E.164 format - mapped to Cognito username via phone lookup cache

SubscriberToken
string [ 5 .. 100 ] characters

Legacy subscriber token used directly as Cognito username (minimum 5 characters)

Password
required
string <password> [ 8 .. 128 ] characters

Subscriber account password - validated against Cognito user pool with HMAC signature

authorizationToken
string^[A-Za-z0-9\-_]+\.[A-Za-z0-9\-_]+\.[A-Za-z0-9...

Pre-authenticated JWT access token for SSO flows - bypasses password authentication

Responses

Request samples

Content type
application/json
Example

Standard subscriber authentication using email and password

{
  • "EmailAddress": "john.doe@grandhotel.com",
  • "Password": "mySecurePassword123"
}

Response samples

Content type
application/json
{
  • "SupportedLocales": {
    },
  • "AuthenticationResult": {
    },
  • "SubscriberToken": "sub_abc123def456",
  • "GivenName": "John",
  • "FamilyName": "Doe",
  • "locale": "en-us",
  • "errorProcessing": false
}

/subscriberconsole/acceptTandC

Complete subscriber account setup by accepting Terms & Conditions and setting a permanent password. Finalizes account activation for new subscribers with temporary passwords.

Required Parameters:

  • Identity - EmailAddress, PhoneNumber, or SubscriberToken for verification
  • TemporaryPassword - Temporary password from registration email
  • NewPassword - New permanent password (minimum 8 characters, becomes WiFi pre-shared key)

Core Actions:

  • Accept Terms & Conditions and log acceptance with timestamp and IP
  • Transition account status from FORCE_CHANGE_PASSWORD to CONFIRMED
  • Set new password as WiFi pre-shared key for network access
  • Mark email as verified in Cognito and complete account confirmation
  • Activate subscriber services and enable network access
  • Send LoginPasswordCreated webhook event

Security & Error Handling:

  • Cryptographic processing with SECRET_HASH and HMAC-SHA256
  • Handles expired temporary passwords with automatic regeneration
  • Prevents duplicate T&C acceptance
  • Complete audit trail with source IP and browser information
Authorizations:
None
Request Body schema: application/json
required
One of
EmailAddress
required
string <email>

Subscriber email address for identity verification

PhoneNumber
string

Subscriber phone number for identity verification (alternative to email)

SubscriberToken
string

Direct subscriber token for identity verification (alternative method)

TemporaryPassword
required
string <password> non-empty

Temporary password received during registration process

NewPassword
required
string <password> >= 8 characters

New permanent password chosen by subscriber (becomes WiFi pre-shared key)

Responses

Request samples

Content type
application/json
Example

Complete account setup using email address verification

{
  • "EmailAddress": "john.doe@grandhotel.com",
  • "TemporaryPassword": "TempPass123",
  • "NewPassword": "MySecurePassword123!"
}

Response samples

Content type
application/json
{
  • "message": "User verified. Password changed. Email verified.",
  • "errorProcessing": false
}

/subscriberconsole/initiateResetConsolePassword

Initiate subscriber console password reset process with smart Cognito status detection and appropriate notification routing.

Required Parameters:

  • AccessToken - Authentication and authorization
  • SubscriberToken - Unique subscriber identifier

Status-Based Processing:

  • CONFIRMED Status - Generates new 8-character cryptographically secure OTP, updates PasswordResetCode with PasswordResetInitiateDateTimeUTC timestamp, sends reset notification
  • FORCE_CHANGE_PASSWORD Status - Resends welcome notification with existing temporary password for new accounts pending T&C acceptance
  • Existing Reset Code - Reuses PasswordResetCode if already set for confirmed accounts
  • Other States - Returns success without notifications for inactive/suspended accounts

Features:

  • Smart multi-channel delivery via NotificationEngine (email or SMS based on preferences)
  • Complete audit trail with source IP, browser, OS, firewall IP, administrator tracking
  • Automatic cache invalidation for immediate data refresh
  • Multi-level authorization with operator scope restriction
  • PII protection through secure data retrieval methods

Response Messages:

  • "Password reset code sent successfully" for CONFIRMED status
  • "Welcome notification resent successfully" for FORCE_CHANGE_PASSWORD status
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid access token for authentication and authorization

SubscriberToken
required
string

Unique subscriber identifier for password reset request

NotificationChannel
string
Enum: "email" "sms"

Optional notification channel preference (email or SMS)

Responses

Request samples

Content type
application/json
Example

Initiate password reset for confirmed subscriber

{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "SubscriberToken": "sub_abc123def456ghi789",
  • "NotificationChannel": "email"
}

Response samples

Content type
application/json
Example
{
  • "message": "Password reset code sent successfully",
  • "errorProcessing": false,
  • "statusCode": 200
}

/subscriberconsole/confirmResetConsolePassword

Complete password reset by validating OTP from email and setting new permanent password.

Required Parameters:

  • AccessToken - Authentication token
  • SubscriberToken - Subscriber identifier
  • OTP - 8-character code from email
  • NewPassword - New password (8-63 characters, becomes WiFi key)

Process:

  • Verify OTP and update password in AWS Cognito
  • Set new password as WiFi WPA2 network key
  • Clear reset code and send confirmation notification
Authorizations:
None
Request Body schema: application/json
required
AccessToken
required
string

Valid access token for authentication

SubscriberToken
required
string

Unique subscriber identifier for the account to reset

OTP
required
string = 8 characters

One-time password received via email from password reset initiation

NewPassword
required
string <password> [ 8 .. 63 ] characters

New permanent password (becomes WiFi pre-shared key)

Responses

Request samples

Content type
application/json

Confirm password reset using the 8-character code received via email

{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "SubscriberToken": "sub_abc123def456",
  • "OTP": "AB12CD34",
  • "NewPassword": "MyNewSecurePassword123!"
}

Response samples

Content type
application/json
{
  • "message": "Password changed."
}

/subscriberconsole/updatePII

Update personal identifiable information and preferences for a subscriber account with role-based access controls.

Required Parameters:

  • AccessToken - Authentication and role-based permissions
  • SubscriberToken - Unique subscriber identifier

Updatable Fields:

  • GivenName/FamilyName - First and last name (alphanumeric, HTML sanitized)
  • PhoneNumber - Formatted to E.164 international standard, validated for uniqueness
  • contactpref_sms - SMS marketing preference (boolean)
  • locale - Language preference (en-us or es-xl)
  • externalSubscriberID - External system identifier (Network Operator only)
  • Status - Account status (Administrator only)

Role-Based Access:

  • Subscriber - Update own profile (name, phone, contact preferences, locale)
  • Network Operator - Full access with domain administrator privileges
  • Venue Administrator - Limited to contact preferences only

Security Features:

  • Input sanitization to prevent HTML/script injection
  • Record locking prevents concurrent modifications
  • AWS Cognito synchronization for contact information
  • Complete audit trail with timestamp and administrator tracking
Authorizations:
None
Request Body schema: application/json
required
AccessToken
required
string

Valid access token for authentication and role-based permissions

SubscriberToken
required
string

Unique subscriber identifier for the account to update

GivenName
string <= 50 characters

First name (alphanumeric and punctuation only, HTML sanitized)

FamilyName
string <= 50 characters

Last name (alphanumeric and punctuation only, HTML sanitized)

PhoneNumber
string

Phone number (will be formatted to E.164 international standard)

contactpref_sms
boolean

SMS contact preference for marketing communications

locale
string
Enum: "en-us" "es-xl"

Language preference for interface localization

externalSubscriberID
string <= 100 characters

External system identifier (Network Operator only)

Status
string
Enum: "Active" "AUP not accepted" "Unknown" "In Service" "Suspended"

Subscriber account status (Administrator only)

Responses

Request samples

Content type
application/json
Example

Self-service profile update with name and contact preferences

{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "SubscriberToken": "sub_abc123def456",
  • "GivenName": "John",
  • "FamilyName": "Doe",
  • "PhoneNumber": "+1-555-123-4567",
  • "contactpref_sms": true,
  • "locale": "en-us"
}

Response samples

Content type
application/json
{
  • "message": ""
}

/subscriberconsole/viewTandC

Retrieve current Terms and Conditions document with locale detection and fallback support.

Required Parameters:

  • AccessToken - Token validation
  • VenueID - Venue context

Optional Parameters:

  • locale - Device locale (default: en-us)
  • EmailAddress - For profile locale lookup

Features:

  • Multi-language support with fallback to en-us
  • Cognito integration for profile locale
  • Domain-specific operator content
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid access token for authentication and domain verification

VenueID
required
string

Venue identifier for context (required parameter)

EmailAddress
string <email>

Optional email address for Cognito profile locale lookup

locale
string

Device locale for T&C content retrieval (defaults to 'en-us')

Responses

Request samples

Content type
application/json
Example

Request Terms & Conditions with default locale

{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "VenueID": "venue_abc123def456"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "DeviceLocale": "en-us",
  • "TandC": "These Terms and Conditions govern your use of the WiFi service provided by the venue. By connecting to this network, you agree to comply with all applicable laws and regulations..."
}

/subscriberconsole/listKeys

Retrieve subscriber WiFi keys with device status and venue configurations.

Required Parameters:

  • AccessToken - Subscriber authentication

Optional Parameters:

  • VenueID - Filter by venue

Returned Data:

  • Subscriber profile and contact info
  • Key statistics (total/active counts)
  • Device statistics (online/offline based on 32-min threshold)
  • WiFi keys with SSID, PSK, creation dates, KeyTag
  • Device details with hostnames, models, online status
  • Unread venue messages
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid access token containing SubscriberToken for authentication

VenueID
string

Optional venue filter to list keys for a specific venue

Responses

Request samples

Content type
application/json

Request subscriber's WiFi keys and device information

{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "VenueID": "venue_abc123def456"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "SubscriberToken": "sub_abc123def456",
  • "EmailAddress": "john.doe@grandhotel.com",
  • "GivenName": "John",
  • "FamilyName": "Doe",
  • "PhoneNumber.E164": "+1-555-123-4567",
  • "locale": "en-us",
  • "contactpref_sms": true,
  • "contactpref_email": true,
  • "KeyCount": 2,
  • "KeyCountActive": 2,
  • "DeviceCountOnline": 2,
  • "DeviceCountOffline": 1,
  • "KeysInKeyPools": {
    },
  • "messages_from_venues": { }
}

/subscriberconsole/refreshAccessToken

Refresh authentication tokens using AWS Cognito refresh token mechanism for continuous session access.

Required Parameters:

  • AccessToken - Current token for user identification
  • RefreshToken - Valid refresh token
  • VenueID - Venue context

Returns:

  • AccessToken - New token (1-hour expiration)
  • RefreshToken - New refresh token (rotated for security)
  • IdToken - Updated identity claims
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Current (potentially expired) access token for user identification

RefreshToken
required
string

Valid refresh token from previous authentication for token renewal

VenueID
required
string

Venue identifier for context and session tracking

Responses

Request samples

Content type
application/json
Example

Refresh tokens for mobile application session

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "RefreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ...",
  • "VenueID": "venue_grandhotel_123"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "AuthenticationResult": {
    }
}

/subscriberconsole/logout

Securely logout by invalidating all active tokens and signing out from all devices.

Required Parameters:

  • AccessToken - Token to identify session
  • VenueID - Venue context

Impact:

  • Invalidates tokens across all devices instantly
  • Signs out user from all logged-in devices
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid access token to identify the user session to terminate

VenueID
required
string

Venue identifier for context

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345"
}

Response samples

Content type
application/json
{
  • "message": "User logged out."
}

/subscriberconsole/updateKeyTag

Assign personalized names to WiFi keys for easier identification.

Required Parameters:

  • AccessToken - Subscriber authentication
  • VenueID - Venue context
  • KeyID - WiFi key identifier
  • KeyTag - Custom label (max 40 characters, HTML sanitized, unique per subscriber)
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier for context

KeyID
required
string

Unique identifier of the WiFi key to update

KeyTag
required
string <= 40 characters

Custom tag/label for the key (max 40 characters, HTML sanitized)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "KeyID": "psk_abc123def456",
  • "KeyTag": "Living Room TV"
}

Response samples

Content type
application/json
{
  • "message": "",
  • "KeyTag": "Living Room TV"
}

/subscriberconsole/updateDeviceName

Assign custom names to connected WiFi devices for easier identification.

Required Parameters:

  • AccessToken - Subscriber authentication
  • VenueID - Venue context
  • Calling-Station-Id - Device MAC address
  • UserDefinedHostName - Custom name (max 40 characters, HTML sanitized, unique per subscriber)
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier for context

Calling-Station-Id
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC address of the device to rename (in standard format with colons or dashes)

UserDefinedHostName
required
string <= 40 characters

Custom name/label for the device (max 40 characters, HTML sanitized)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "Calling-Station-Id": "AA:BB:CC:DD:EE:FF",
  • "UserDefinedHostName": "Living Room Smart TV"
}

Response samples

Content type
application/json
{
  • "message": "",
  • "Calling-Station-Id": "AA:BB:CC:DD:EE:FF",
  • "UserDefinedHostName": "Living Room Smart TV"
}

/subscriberconsole/cancelSubscription

Cancel subscription with access preserved until end of current billing cycle.

Required Parameters:

  • AccessToken - Subscriber authentication
  • VenueID - Subscription context

Optional Parameters:

  • endImmediately - End immediately (default: false)
  • NewEndDateTimeUTC.ISO8601 - Custom end date

Returns:

  • endDate - Calculated subscription end date
  • billingCycleEnd - End of current billing cycle
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier for the subscription context

endImmediately
boolean
Default: false

Optional flag to end subscription immediately instead of at billing cycle end

NewEndDateTimeUTC.ISO8601
string <date-time>

Optional custom end date for subscription (ISO 8601 format)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "endImmediately": false
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "endDate": "2024-12-31T23:59:59.999Z",
  • "billingCycleEnd": "2024-12-31T23:59:59.999Z"
}

/subscriberconsole/listPayments

Access payment transaction records with billing details, receipts, and subscription information.

Required Parameters:

  • AccessToken - Subscriber authentication
  • VenueID - Venue context

Optional Parameters:

  • MaxInvoiceDateTimeUTC.ISO8601 - Show payments before timestamp
  • MinInvoiceDateTimeUTC.ISO8601 - Show payments after timestamp (default: last 2 years)
  • ServicePlanID - Filter by service plan
  • UnitID_internal - Filter by unit

Returns: Payment records with invoice dates, amounts, Stripe receipt URLs, refund tracking, service details, and venue information ordered by invoice date.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier for filtering payments

MaxInvoiceDateTimeUTC.ISO8601
string <date-time>

Show payments with invoice date before this timestamp

MinInvoiceDateTimeUTC.ISO8601
string <date-time>

Show payments with invoice date after this timestamp

ServicePlanID
string

Filter by specific service plan identifier

UnitID_internal
string

Filter by internal unit identifier

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "MinInvoiceDateTimeUTC.ISO8601": "2024-01-01T00:00:00.000Z",
  • "MaxInvoiceDateTimeUTC.ISO8601": "2024-12-31T23:59:59.999Z"
}

Response samples

Content type
application/json
{
  • "message": "",
  • "PaymentCount": 3,
  • "NonZeroPaymentCount": 2,
  • "BillingCycleHours": 2160,
  • "DownloadKbps": 300000,
  • "UploadKbps": 30000,
  • "PricePerDownloadGbps.USD": 99,
  • "VenuePriceAdjustment": 0,
  • "VenueUnitPriceAdjustment": 0,
  • "ListBillingCyclePrice.USD": 59.97,
  • "NetBillingCyclePrice.USD": 59.97,
  • "Payments": [
    ]
}

/subscriberconsole/addTicket

Submit technical issues, service requests, or assistance tickets with ConnectWise integration.

Required Parameters:

  • AccessToken - Subscriber authentication
  • VenueID - Venue context
  • contactName - Contact name (max 40 characters)
  • summary - Brief description (max 100 characters)

Optional Parameters:

  • contactEmailAddress - Contact email (defaults to subscriber email)
  • contactPhoneNumber - Phone for follow-up
  • Description - Detailed explanation
  • unitID/VAULTUnitID/CustomUnit - Unit identification
  • TicketType/TicketSubType - Categorization
  • serviceboardid - ConnectWise board routing

Returns: ConnectWise ticket ID, reference number, status, company/site info, and board assignment.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier where the issue is occurring

contactName
required
string <= 40 characters

Contact person name for the ticket (max 40 characters)

summary
required
string <= 100 characters

Brief summary of the issue or request (max 100 characters)

contactEmailAddress
string <email>

Contact email address (defaults to subscriber email if not provided)

contactPhoneNumber
string

Contact phone number for follow-up

Description
string

Detailed description of the issue or request

unitID
string

Specific unit identifier within the venue

VAULTUnitID
string

VAULT-specific unit identifier

CustomUnit
string

Custom unit description if unit ID not available

TicketType
string

Type of ticket for categorization

TicketSubType
string

Sub-category of the ticket

serviceboardid
integer

ConnectWise service board ID for routing

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "contactName": "John Doe",
  • "summary": "Internet connectivity issues",
  • "contactEmailAddress": "john.doe@example.com",
  • "Description": "WiFi connection drops frequently throughout the day",
  • "unitID": "unit_101",
  • "TicketType": "Resident Support",
  • "TicketSubType": "Internet"
}

Response samples

Content type
application/json
{
  • "ticketId": "12345",
  • "ticketNumber": "TKT-2025-001234",
  • "status": "New",
  • "company": {
    },
  • "site": {
    },
  • "board": {
    }
}

/subscriberconsole/listKeySessions

Retrieve session usage data and analytics for WiFi authentication keys including bandwidth consumption and connection history.

Required Parameters:

  • AccessToken - Subscriber authentication token
  • VenueID - Venue identifier for filtering usage data

Optional Parameters:

  • KeyID - Specific WiFi key identifier to filter usage data
  • Calling-Station-Id - MAC address to filter device-specific sessions
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier for filtering usage data

KeyID
string

Optional specific WiFi key identifier to filter usage data

Calling-Station-Id
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

Optional device MAC address to filter by specific device

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "KeyID": "psk_abc123def456"
}

Response samples

Content type
application/json
Example
{
  • "UsageData": [
    ]
}

/subscriberconsole/listPaymentMethod

Retrieve payment method details for subscriber subscription including card and wallet information.

Required Parameters:

  • SubscriberToken - Subscriber identifier
  • StripeClientSecret - Client secret for secure access

Returns:

  • SetupSuccessDateTimeUTC.ISO8601 - Payment method setup timestamp
  • card - Funding type, brand, expiration, last 4 digits
  • wallet - Type (Apple/Google/Samsung Pay), dynamic_last4
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
SubscriberToken
required
string

Unique identifier for the subscriber requesting payment method details

StripeClientSecret
required
string

Client secret from Stripe for secure payment method access

Responses

Request samples

Content type
application/json
{
  • "SubscriberToken": "sub_1234567890abcdef",
  • "StripeClientSecret": "pi_1234567890_secret_abc123def456"
}

Response samples

Content type
application/json
Example
{
  • "SetupSuccessDateTimeUTC.ISO8601": "2024-01-15T10:30:00.000Z",
  • "card": {
    }
}

/subscriberconsole/listDeviceSessions

Retrieve detailed analytics for device connection sessions including bandwidth usage, session duration, and connection quality metrics.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid subscriber access token for authentication

VenueID
string

Optional venue filter to show sessions for specific venue only

KeyID
string

Optional key filter to show sessions for specific access key only

Calling-Station-Id
string

Optional device MAC address filter for specific device analytics

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Response samples

Content type
application/json
Example
{
  • "UsageData": [
    ]
}

/subscriberconsole/resetKey

Reset and regenerate WiFi authentication keys for secure credential lifecycle management with optional custom key values.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
One of
AccessToken
required
string

Valid subscriber access token for authentication

CurrentKeyID
required
string

ID of the current key to be reset/replaced

NewKey
required
string [ 8 .. 63 ] characters ^[!-~]*$

Complete new WiFi password (8-63 characters, WPA2 compliant)

UserPartForNewKey
string <= 40 characters ^[!-~]*$

Custom prefix for new key (max 40 characters), system will append subscriber token

dryRun
boolean

If true, validates new key without making changes

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "CurrentKeyID": "key_abc123def456",
  • "NewKey": "MyNewSecurePassword2024!"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "newKeyId": "key_def456ghi789",
  • "message": "WiFi password updated successfully. All devices will need to reconnect.",
  • "venues": [
    ],
  • "units": [
    ]
}

/subscriberconsole/acknowledgeMessageFromVenue

Mark venue messages as acknowledged by subscriber to update message read status and notification tracking.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid subscriber access token for authentication

MessageID
required
string

Unique identifier of the venue message to acknowledge

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "MessageID": "msg_abc123def456"
}

Response samples

Content type
application/json
Example
{
  • "message": "Message acknowledged by subscriber."
}

/subscriberconsole/modifyServicePlan

Modify service plan selections and upgrade or downgrade subscription tiers for subscriber accounts.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "newServicePlanID": "plan_premium_unlimited",
  • "billingAdjustment": 15,
  • "effectiveDate": "2024-01-15T10:30:00.000Z",
  • "message": "Service plan updated successfully. New features are now active.",
  • "subscription": {
    }
}

/subscriberconsole/listSubscriberLog

Retrieve subscriber activity logs including account actions, service changes, and system events for audit tracking.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid subscriber access token for authentication

VenueID
string

Optional venue filter to show logs for specific venue only

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Response samples

Content type
application/json
Example
{
  • "log": [
    ]
}

/venuemgmtconsole/subscribers/resendCodeforTandC

Resend Terms & Conditions notifications to subscribers who completed setup intent but need communications resent through preferred channel.

Required Parameters:

  • AccessToken - Venue administrator authentication
  • VenueID - Venue context
  • One of: EmailAddress, PhoneNumber, or SubscriberToken for subscriber identification

Optional Parameters:

  • NotificationChannel - Delivery method: email or sms (auto-selected if not specified)

Core Functionality:

  • Multi-Channel Delivery - Email and SMS support with operator branding
  • Venue Validation - Ensures valid subscription setup intent at specified venue
  • Delayed Billing Support - Specifically for subscribers with delayed billing arrangements
  • Channel Selection - Automatic or manual with smart priority based on preferences
  • Access Control - Venue administrator with operator relationship verification

Returns: Success confirmation with delivery status.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
One of
AccessToken
required
string

Cognito authentication token for venue administrator with network operator permissions

VenueID
required
string

Unique venue identifier where the subscriber has a setup intent with delayed billing

EmailAddress
required
string <email>

Subscriber email address for identification (one identification method required)

PhoneNumber
string

Subscriber phone number for identification (one identification method required)

SubscriberToken
string

Internal subscriber token for direct identification (one identification method required)

NotificationChannel
string
Enum: "email" "sms"

Preferred notification delivery method for Terms & Conditions communication

Responses

Request samples

Content type
application/json
Example

Venue administrator resending Terms & Conditions email using subscriber email

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "EmailAddress": "guest@grandhotel.com"
}

Response samples

Content type
application/json
Example

Terms & Conditions email delivered successfully

{
  • "message": "",
  • "errorProcessing": false
}

Shopping Cart

🛒 Shopping Cart & E-commerce

Complete e-commerce functionality for venue browsing, service selection, and checkout processes for prospective subscribers.

Shopping Experience

  • 🏢 Venue Discovery: Browse available venues with service offerings
  • 📋 Service Selection: Choose service plans, add-ons, and customization options
  • 🛒 Cart Management: Add, remove, modify items and calculate pricing
  • 💳 Checkout Process: Secure payment processing and account creation
  • 📊 Pricing Engine: Dynamic pricing, promotions, and discount calculations
  • 🎯 Recommendations: Intelligent service suggestions and upselling

E-commerce Features

  • 💰 Multiple Payment Methods: Credit cards, ACH, and alternative payment options
  • 🎫 Promotional Codes: Discount codes, special offers, and campaign tracking
  • 📱 Multi-Platform: Web, mobile, and API-driven shopping experiences
  • 📊 Analytics: Conversion tracking, abandoned cart recovery, sales metrics

/networkoperatorconsole/shoppingcart/listServicePlans

Retrieve service plan catalog for network operator venues with multi-currency pricing, FCC regulatory compliance, trial cycle management, and venue-specific customizations.

Required Parameters:

  • AccessToken - Cognito network operator authentication
  • Either: VenueID or UnitID_internal (format: *._V3VENUE)

Optional Parameters:

  • ShoppingCartEnabled - Filter plans for customer-facing interfaces (excludes bulk/low-speed plans)

Processing:

  • Access Validation - Verify authentication and venue/unit permissions
  • Currency Detection - Auto-determine currencies based on venue unit countries
  • Price Calculation - Apply venue/unit-level adjustments with multi-currency support
  • FCC Integration - Include broadband labels, speed specs, policy URLs, customer support
  • Trial Cycle Processing - Calculate trial cycles with venue/unit adjustments

Returns: Service plans with bandwidth specs (upload/download speeds), device limits, session management, SMS codes, pricing (multi-currency), trial configurations, FCC compliance data. Plans sorted by upload speed.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
VenueID
string.*\._V3VENUE$

Internal venue identifier for venue-level service plan retrieval (required if UnitID_internal not provided)

UnitID_internal
string.*\._V3VENUE$

Internal unit identifier for unit-specific service plan retrieval (required if VenueID not provided)

ShoppingCartEnabled
boolean
Default: false

Enable shopping cart mode with filtered plans (excludes bulk and low-speed plans under 10 Mbps)

Responses

Request samples

Content type
application/json
Example
{
  • "VenueID": "venue_opera_house_sf._V3VENUE",
  • "ShoppingCartEnabled": false
}

Response samples

Content type
application/json
Example
{
  • "errorProcessing": false,
  • "message": "",
  • "AvailableServicePlans": [
    ],
  • "AvailableServicePlanCount": 2
}

/networkoperatorconsole/shoppingcart/requestSubscription

Process new subscription requests with Stripe payment integration, unit assignment, and automated service provisioning.

Core Functionality:

  • Payment Processing - Stripe payment intent verification and delayed billing support
  • Unit Assignment - Venue unit allocation with availability checks
  • Customer Validation - Identity verification and fraud protection
  • Service Activation - Automated account creation and provisioning

Parameters: StripeClientSecret, VenueID, UnitID_internal or externalVenueUnitID, EmailAddress, SubscriberToken, external IDs for integration, SetupIntentId.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
StripeClientSecret
string

Stripe payment intent client secret for payment processing

VenueID
string.*\._V3VENUE$

Internal venue identifier for subscription assignment

UnitID_internal
string.*\._V3VENUE$

Internal unit identifier for specific unit assignment

externalVenueUnitID
string

External unit identifier for property management integration

EmailAddress
string <email>

Customer email address for subscription and communications

SubscriberToken
string

Unique subscriber identification token

externalSubscriberID
string

External subscriber identifier for CRM integration

externalSubscriptionID
string

External subscription identifier for billing integration

SetupIntentId
string

Stripe setup intent identifier for payment method setup

Responses

Request samples

Content type
application/json
{
  • "StripeClientSecret": "pi_3KJ123ABC_secret_xyz789",
  • "VenueID": "venue_12345._V3VENUE",
  • "UnitID_internal": "unit_67890._V3VENUE",
  • "externalVenueUnitID": "UNIT-101",
  • "EmailAddress": "customer@example.com",
  • "SubscriberToken": "sub_token_abc123xyz",
  • "externalSubscriberID": "CRM-CUST-001",
  • "externalSubscriptionID": "BILLING-SUB-001",
  • "SetupIntentId": "seti_1KJ123ABC_xyz789"
}

Response samples

Content type
application/json
{
  • "errorProcessing": false,
  • "message": "Subscription request processed successfully",
  • "psk": "wifi_key_abc123xyz",
  • "subscriptionId": "sub_12345._V3SUB",
  • "setupStatus": "completed",
  • "paymentStatus": "succeeded",
  • "unitAssignment": {
    }
}

/networkoperatorconsole/shoppingcart/listVenues

Retrieve venue listings for shopping cart integration and public subscription services.

Access Control:

  • Network Operators - Full venue access with administrative details
  • Public Access - Shopping cart enabled venues only
  • Subscribers - Complete venue listings with subscription compatibility

Venue Information:

  • Basic Details - VenueID, name, address, coordinates, contact info
  • Shopping Cart - Enablement status, service plans, pricing, terms
  • Statistics - Unit counts, active subscribers, device inventory, utilization
  • Network Config - WiFi availability, service plan compatibility, regional access

Features: Location-based filtering, service plan compatibility, capacity-based selection, multi-locale support, response format varies by access level (array for public, object for administrative).

Authorizations:
CognitoAuthNone
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token (optional for public shopping cart access)

ShoppingCartEnabled
boolean

Filter venues by shopping cart availability (default: true for this endpoint)

object

Geographic filtering criteria for venue selection

object

Service plan filtering criteria

Responses

Request samples

Content type
application/json
Example

Public browsing of venues available for subscription

{
  • "AccessToken": "",
  • "ShoppingCartEnabled": true
}

Response samples

Content type
application/json
Example
{
  • "message": "Venues retrieved successfully",
  • "errorProcessing": false,
  • "data": [
    ],
  • "SupportedLocales": {
    }
}

/networkoperatorconsole/shoppingcart/listVenueUnits

Retrieve complete venue unit inventory with subscription compatibility information for shopping cart integration.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token from Cognito with venue management privileges

VenueID
required
string

Unique venue identifier for unit inventory retrieval

ServicePlanID
string

Optional service plan ID for compatibility filtering and availability calculations

StartDateTimeUTC.ISO8601
string <date-time>

Optional start date for availability calculations and occupancy filtering

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "USA.CA.90210.LUXURYAPTS.BEVERLYHILLS"
}

Response samples

Content type
application/json
{
  • "message": "Venue unit inventory retrieved successfully",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "VenueUnitCount": 150,
  • "VenueUnits": [
    ],
  • "dateUpdated": "2025-09-12T19:35:05.456Z"
}

/networkoperatorconsole/shoppingcart/addSubscriptionPayment

Process subscription payments with comprehensive financial management including Stripe integration and multi-currency support.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token from Cognito with payment processing privileges

VenueID
required
string

Unique venue identifier for payment processing context

SubscriberToken
string

Subscriber authentication token for payment authorization

PaymentMethodID
string

Stripe payment method identifier for transaction processing

Amount
number <double>

Payment amount in venue currency

Currency
string

Payment currency code (ISO 4217)

PaymentDescription
string

Description of payment for receipt and record keeping

AutomaticPaymentMethods
boolean

Enable automatic payment method selection and processing

ConfirmPayment
boolean

Immediately confirm payment after processing

SendReceipt
boolean

Send payment receipt to customer email

object

Additional payment metadata for tracking and analytics

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "USA.CA.90210.LUXURYAPTS.BEVERLYHILLS",
  • "SubscriberToken": "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIn0...",
  • "PaymentMethodID": "pm_1J5K6L7M8N9O0P1Q2R3S4T5U",
  • "Amount": 49.99,
  • "Currency": "USD",
  • "PaymentDescription": "Monthly subscription payment - Premium 1000 Mbps Internet",
  • "AutomaticPaymentMethods": true,
  • "ConfirmPayment": true,
  • "SendReceipt": true
}

Response samples

Content type
application/json
{
  • "message": "Subscription payment processed successfully",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "PaymentIntentID": "pi_1J5K6L7M8N9O0P1Q2R3S4T5U",
  • "PaymentStatus": "succeeded",
  • "TransactionID": "TXN_2025091219350567890",
  • "PaymentAmount": 49.99,
  • "Currency": "USD",
  • "PaymentMethodDetails": {
    },
  • "ReceiptURL": "https://pay.stripe.com/receipts/payment/CAcbhNGlasdfghj123...",
  • "ProcessingFee": 1.75,
  • "NetAmount": 48.24,
  • "PaymentDate": "2025-09-12T19:35:06.123Z",
  • "NextBillingDate": "2025-10-12T19:35:06.123Z",
  • "SubscriptionDetails": {
    }
}

/networkoperatorconsole/shoppingcart/listSubscriptions

Retrieve comprehensive subscription information with analytics, filtering capabilities, and export options for subscription management.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token from Cognito with subscription management privileges

EmailAddress
string <email>

Filter by customer email address (case-insensitive)

SubscriberToken
string

Filter by specific subscriber authentication token

StripeCustomerID
string

Filter by Stripe customer identifier

PhoneNumber.E164
string

Filter by phone number in E164 format

VenueID
string

Filter by venue identifier

UnitID_internal
string

Filter by internal unit identifier

ServicePlanID
string

Filter by service plan identifier

externalSubscriberID
string

Filter by external customer management system subscriber ID

externalSubscriptionID
string

Filter by external subscription system identifier

externalServicePlanID
string

Filter by external service plan identifier

paymentFailed
string
Enum: "true" "false"

Filter by payment failure status

AccountStatusAtCreation
string

Filter by account status when subscription was created

MaxViewWindowDateUTC.ISO8601
string <date-time>

Maximum date filter for subscription start date

MinViewWindowDateUTC.ISO8601
string <date-time>

Minimum date filter for subscription end date

onlyDisplayPendingSubscriptions
boolean

Show only pending subscriptions awaiting setup completion

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "message": "Subscription list retrieved successfully",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "SubscriptionCount": 2,
  • "Subscriptions": [
    ],
  • "Subscriptions_csv": [ ]
}

/networkoperatorconsole/shoppingcart/listStripePayments

Analyze Stripe payment transactions with comprehensive filtering, financial intelligence, and transaction analytics.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token from Cognito with payment analytics privileges

EmailAddress
string <email>

Filter by customer email address

SubscriberToken
string

Filter by specific subscriber authentication token

StripeCustomerID
string

Filter by Stripe customer identifier

PhoneNumber.E164
string

Filter by phone number in E164 format

VenueID
string

Filter by venue identifier

UnitID_internal
string

Filter by internal unit identifier

ServicePlanID
string

Filter by service plan identifier

externalSubscriberID
string

Filter by external customer management system subscriber ID

externalSubscriptionID
string

Filter by external subscription system identifier

externalVenueUnitID
string

Filter by external unit identifier

externalVenueID
string

Filter by external venue identifier

externalServicePlanID
string

Filter by external service plan identifier

MaxStartDateTimeUTC.ISO8601
string <date-time>

Maximum subscription start date filter

MinStartDateTimeUTC.ISO8601
string <date-time>

Minimum subscription start date filter

MaxInvoiceDateTimeUTC.ISO8601
string <date-time>

Maximum invoice date filter

MinInvoiceDateTimeUTC.ISO8601
string <date-time>

Minimum invoice date filter (defaults to 2 years ago if not provided)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "message": "Payment transaction list retrieved successfully",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "PaymentCount": 2,
  • "NonZeroPaymentCount": 2,
  • "BillingCycleHours": 720,
  • "DownloadKbps": 1024000,
  • "UploadKbps": 1024000,
  • "PricePerDownloadGbps.USD": 50,
  • "VenuePriceAdjustment": -10,
  • "VenueUnitPriceAdjustment": 0,
  • "Payments": [
    ],
  • "MaxInvoiceDateTimeUTC.ISO8601": "2025-12-31T23:59:59Z",
  • "MinInvoiceDateTimeUTC.ISO8601": "2023-09-12T19:35:07.456Z"
}

/networkoperatorconsole/shoppingcart/listPayments

Access comprehensive payment history with multi-method transaction analytics including Stripe, offline, and manual payment processing.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token from Cognito with comprehensive payment analytics privileges

EmailAddress
string <email>

Filter by customer email address

SubscriberToken
string

Filter by specific subscriber authentication token

StripeCustomerID
string

Filter by Stripe customer identifier

PhoneNumber.E164
string

Filter by phone number in E164 format

VenueID
string

Filter by venue identifier

UnitID_internal
string

Filter by internal unit identifier

ServicePlanID
string

Filter by service plan identifier

externalSubscriberID
string

Filter by external customer management system subscriber ID

externalSubscriptionID
string

Filter by external subscription system identifier

externalVenueUnitID
string

Filter by external unit identifier

externalVenueID
string

Filter by external venue identifier

externalServicePlanID
string

Filter by external service plan identifier

MaxStartDateTimeUTC.ISO8601
string <date-time>

Maximum subscription start date filter

MinStartDateTimeUTC.ISO8601
string <date-time>

Minimum subscription start date filter

MaxInvoiceDateTimeUTC.ISO8601
string <date-time>

Maximum invoice date filter

MinInvoiceDateTimeUTC.ISO8601
string <date-time>

Minimum invoice date filter (defaults to 2 years ago if not provided)

PaymentMethod
string
Enum: "stripe" "cash" "bank_transfer" "check" "all"

Filter by payment method type

PaymentStatus
string
Enum: "succeeded" "pending" "failed" "refunded" "disputed"

Filter by payment processing status

MinAmount
number <double>

Minimum payment amount filter

MaxAmount
number <double>

Maximum payment amount filter

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "message": "Multi-method payment history retrieved successfully",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "PaymentCount": 3,
  • "NonZeroPaymentCount": 3,
  • "TotalRevenue": 269.97,
  • "StripeRevenue": 179.98,
  • "CashRevenue": 89.99,
  • "PaymentMethodBreakdown": {
    },
  • "Payments": [
    ],
  • "MaxInvoiceDateTimeUTC.ISO8601": "2025-12-31T23:59:59Z",
  • "MinInvoiceDateTimeUTC.ISO8601": "2023-09-12T19:35:07.789Z"
}

/networkoperatorconsole/shoppingcart/getStripeReceiptURL

Retrieve Stripe-hosted payment receipt URL for a completed transaction using StripeClientSecret identifier.

Required Parameters:

  • StripeClientSecret - Unique Stripe client secret for transaction identification

Returns:

  • StripeReceiptURL - Secure URL for payment receipt (empty string if unavailable for pending/failed transactions)
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
StripeClientSecret
required
string

The unique Stripe client secret identifier associated with the payment transaction. This secret is used to locate the specific payment intent and retrieve its associated receipt URL from the transaction records.

Responses

Request samples

Content type
application/json

Request to retrieve the receipt URL for a specific payment transaction

{
  • "StripeClientSecret": "pi_3JDOE2JdtcKntT1B0dPbfmtc_secret_0HfC5v2e"
}

Response samples

Content type
application/json
Example

/operatorconsole/config/listDisplayOptions

🎨 Fetch UI Display Configuration Settings

Retrieves display options for operator or venue interfaces, enabling dynamic UI configuration and branding. This endpoint supports access-based filtering with granular permission controls.

🔐 Access Control Tiers

  • NetworkSoftwareProvider: Full access to all display options
  • NetworkOperator: Access to operator-specific display configurations
  • Public: Limited access requiring specific DisplayOptionID parameter

📋 Feature Capabilities

  • Display Theme Management: Color schemes and visual presentation parameters
  • Branding Configuration: Logo placement, sizing, and visibility settings
  • Interface Layout Controls: Panel arrangement and component visibility
  • Localization Settings: Language preferences and regional format options
  • Filter Functionality: Search by DisplayOptionName or DisplayOptionID

🔄 Optimized Retrieval

  • Fast caching using display option sets
  • Efficient access with appropriate context keys

🌐 Multi-Tenant Support

  • Operator-specific display configurations
  • Role-based access control for settings visibility
  • Support for multiple locales including English and Spanish
Authorizations:
CognitoAuthNone
Request Body schema: application/json
required
AccessToken
string

Authentication token for the current session (required if DisplayOptionID not provided)

DisplayOptionID
string

ID to filter for a specific display option (required if AccessToken not provided)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "DisplayOptionID": "string"
}

Response samples

Content type
application/json
{
  • "DisplayOptions": [
    ],
  • "SupportedLocales": { },
  • "message": "string",
  • "errorProcessing": false
}

Venues

🏢 Venue Management & Administration

Comprehensive venue management system for property owners, managers, and network operators to oversee venue operations and subscriber services.

Venue Administration

  • 🏗️ Property Setup: Create and configure new venue properties
  • 📋 Unit Management: Building units, floor plans, and occupancy tracking
  • ⚙️ Service Configuration: Available plans, pricing, and service parameters
  • 👥 Staff Management: Venue administrator assignments and permissions
  • 📊 Operations Dashboard: Real-time venue metrics and performance monitoring
  • 🔧 Equipment Management: CPE deployment, monitoring, and maintenance

Multi-Level Management

  • 🏢 Portfolio View: Multi-venue management for property management companies
  • 📈 Analytics Suite: Revenue tracking, occupancy rates, and service adoption
  • 🎯 Marketing Tools: Service promotions, resident communications, and campaigns
  • ⚙️ Integration Hub: Property management system integration and data sync

/venuemgmtconsole/venues/listVenues

Retrieve venues with role-based filtering and access control for venue management.

Authorizations:
CognitoAuthNone
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication access token or empty string for public access.

  • Valid access token enables role-based filtering based on token claims
  • Empty string provides public access to venues where shopping cart is enabled
  • Access category determined from token claims: NetworkSoftwareProvider, NetworkOperator, Venue, Subscriber, or Public

Responses

Request samples

Content type
application/json
Example

Request from network operator with domain administrator privileges

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
Example

Object format with aggregated statistics for authenticated subscriber

{
  • "VenueList": {
    },
  • "VenueCount": 1,
  • "UnitCount_GlobalWirelessPlusLocalWiredAccess": 247,
  • "UnitCount_LocalWirelessAccess": 89,
  • "PolicyCount_GlobalWirelessPlusLocalWiredAccess": 198,
  • "PolicyCount_LocalWirelessAccess": 67,
  • "DeviceCount": 456,
  • "OnlineDeviceCount": 389,
  • "errorProcessing": false,
  • "message": "Venues retrieved successfully"
}

/venuemgmtconsole/venues/listVenueBuildings

Retrieves a list of unique building identifiers within a specified venue for property management and administrative purposes. This endpoint provides essential organizational data for multi-building properties by extracting distinct building names from all venue units.

Key Features:

  • Building Discovery: Retrieves all unique building identifiers from venue units
  • Automatic Deduplication: Returns only distinct building names to prevent duplicates
  • Relationship Queries: Efficient lookup through venue hierarchies for real-time data
  • Access Control: Venue-specific access through authenticated network operator permissions

Data Processing Flow:

  1. Operator Validation: Validates authenticated network operator credentials
  2. Venue Access Check: Validates venue operation relationship
  3. Unit Discovery: Retrieves all venue units within the specified venue
  4. Building Extraction: Extracts UnitBuilding property values
  5. Deduplication: Automatically removes duplicate building identifiers
  6. Response Assembly: Returns clean list of unique building names

Use Cases:

  • Property Management: Building-based unit organization and assignment
  • Administrative Interfaces: Building selection in venue management dashboards
  • Maintenance Coordination: Route work orders and services by building
  • Capacity Planning: Resource allocation across building structures
  • Emergency Response: Building identification for safety procedures

Access is controlled through Cognito authentication with venue-specific permissions ensuring users only access buildings in venues they are authorized to manage.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token for venue administrator access. The token must belong to a user with administrative permissions for the specified venue through the network operator relationship.

VenueID
required
string

Unique venue identifier to retrieve building information from. The system will query all venue units associated with this venue ID to extract unique building identifiers.

Responses

Request samples

Content type
application/json
Example

Request from venue administrator to list buildings in their managed venue

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345"
}

Response samples

Content type
application/json
Example
{
  • "UnitBuildings": [
    ],
  • "message": ""
}

/venuemgmtconsole/venues/listVenueDetails

Retrieve comprehensive venue information including property management, network equipment, subscriber data, service plans, integrations, and display configurations.

Required Parameters:

  • AccessToken - Cognito authentication with venue access
  • VenueID - Venue identifier

Returns - Venue Profile:

  • Basic Information - VenueID, VenueName, NAS-Identifier, externalVenueID, VenueType (WIRED+WIFI/WIRED+WIFI+SUPPORT/etc), dateAddedUTC
  • Location Details - Full address, City, State, Country (ISO3166A3), PostalCode, TimeZone info (TZ, TimeZoneOffset)
  • Contact Information - PrimaryContactGivenName, PrimaryContactFamilyName, PrimaryContactEmailAddress, PrimaryContactPhoneNumber.E164, SupportEmailAddress, SupportPhoneNumber.E164
  • DeviceCount - Current connected devices at venue

Returns - Display Configuration:

  • DisplayOptionID - Active display theme identifier
  • DisplayConfiguration.ThemeLight/ThemeDark - Logo URLs, color schemes (Background, Primary, Secondary, Text colors), Banner colors, Navbar, Modal, InputBox colors
  • DisplayConfiguration.MetaData - FavIconHRef, TitleTextContent, DescriptionContent
  • DisplayConfiguration.Behavior - CancellationMethod, PrivacyPolicyURL, AllowedLocales, ShowTour, S3Directory paths, GoogleAnalyticsID
  • DisplayConfiguration.Support - ShowSupportLinks, ExternalSupportSystemURL, SupportEmailAddress, SupportPhoneNumber.E164
  • DisplayConfiguration.ShoppingCart - enableShoppingCart, AllowSelfCancellation, AllowSelfPaymentMethodUpdate, AllowSelfServicePlanUpdate

Returns - Shopping Cart & Billing:

  • ShoppingCart.enableShoppingCart - Shopping cart activation status
  • ShoppingCart.Currencies - Array of supported currencies based on venue/unit countries
  • ShoppingCart.ShoppingCartPriceAdjustment.[Currency] - Price adjustments per currency
  • ShoppingCart.hasVenueUnitShoppingCartPriceAdjustment - Unit-level price customization flag
  • ShoppingCart.TrialCycleAdjustment - Trial period adjustment in hours
  • WelcomeEmail_countdown_hours - Welcome email timing configuration

Returns - Subscription Configuration:

  • Email/SMS Preferences - suppressSubscriberEmails, sendSubscriptionAddedEmail, sendSubscriptionEndEmail, suppressSubscriberSMS
  • Reporting Settings - ReportingSubscriptionEnd_lookahead_hours, ReportingSubscriptionEnd_frequency_hours
  • Service Plan Defaults - DefaultServicePlanID for GlobalWirelessPlusLocalWiredAccess and LocalWirelessAccess
  • Subscription Durations - DefaultSubscriptionDurationHours for different access types
  • allowOverlappingSubscriptionWiredUnit - Multiple subscription policy

Returns - VLAN Configuration:

  • Auto-Generated VLAN Ranges - Min/Max ranges for GlobalWirelessPlusLocalWiredAccess, LocalWirelessAccess, GlobalWirelessRoaming
  • Default ranges: 1050-4095 per access type

Returns - Integrations:

  • RealPage PMS - RealPageURL, RealPageAPIKey, RealPagePMCId, RealPageSiteId, enableRealPageSync, RealPageSyncDateTimeUTC
  • Integrations.Ruckus - URL, TenantID, APIClientID, DPSKPoolID, enableSync (APIClientSecret masked)
  • Integrations.ConnectWise - serviceboardid, CompanyID, ClientID (URL and Authorization excluded for venue console)
  • Integrations.PRTG - URL, PRTGUsername (password excluded)

Returns - FCC Compliance:

  • FCCLabel.displayLabel - Whether to display FCC broadband label
  • FCCLabel.TypicalLatency - Typical network latency in milliseconds (-1 if not configured)

Returns - Administrative Staff:

  • VenueAdministrators - Array of venue administrator emails
  • LeasingAgents - Array of leasing agent emails

Additional Returns: Property management group details, network operator connections, WiFi keypools with SSIDs, core equipment status, available service plans, unit organization by building/floor, active subscriptions, and utilization metrics.

Access Control: Role-based venue visibility through Cognito authentication. Sensitive integration credentials are masked for venue management console users.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token for user verification and role-based access control. Must belong to a user with administrative access to the specified venue.

VenueID
required
string^[a-zA-Z0-9_-]+$

Unique venue identifier to retrieve comprehensive details for

Responses

Request samples

Content type
application/json
Example

Request from venue administrator to view detailed venue information

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345"
}

Response samples

Content type
application/json
{
  • "venue_12345": {
    }
}

/venuemgmtconsole/venues/listVenueLog

Retrieve audit trail and activity logs for venue operations, administrative actions, and system events with chronological ordering.

Required Parameters:

  • AccessToken - Cognito authentication with audit log permissions
  • VenueID - Venue identifier (or externalVenueID)

Optional Parameters:

  • externalVenueID - External venue ID (takes precedence over VenueID)

Log Categories: Configuration changes, administrative actions, system events, integration activities.

Filtering: Venue administrators see filtered logs (excludes network equipment and SIEM), network operators see complete logs. Returns most recent 100 entries with administrator profile enrichment.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token for venue administrator access with audit log permissions

VenueID
required
string

Unique venue identifier to retrieve activity logs for. The system queries audit logs associated with this venue ID including administrative actions and system events.

externalVenueID
string

Optional external venue identifier used by integrated systems. When provided, the system automatically resolves this to the internal venue ID for log retrieval. Takes precedence over VenueID when both are specified.

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345"
}

Response samples

Content type
application/json
Example
{
  • "VenueID": "venue_12345",
  • "log": [
    ],
  • "message": ""
}

/venuemgmtconsole/venues/listVenueUsageData

Retrieves comprehensive daily bandwidth usage statistics for all units within a venue, providing detailed consumption data for network monitoring and billing purposes. The endpoint supports timezone-aware reporting with automatic date calculations based on venue location.

Key Features:

  • Daily Usage Aggregation: Pre-calculated bandwidth consumption data aggregated by venue unit
  • Timezone Awareness: Automatic timezone detection and adjustment based on venue location
  • Flexible Date Selection: Support for specific date reporting or automatic previous-day calculations
  • Unit-Level Granularity: Individual bandwidth statistics per venue unit with building/floor organization
  • Data Validation: Automatic correction of negative byte counts and comprehensive error handling

Usage Metrics Provided:

  • Input Octets: Downstream bandwidth (data downloaded by subscribers)
  • Output Octets: Upstream bandwidth (data uploaded by subscribers)
  • Total Octets: Combined bandwidth usage for comprehensive analysis
  • Unit Organization: Building, floor, and unit identifiers for detailed reporting

Date Processing:

  • Default Behavior: Returns previous day's usage data adjusted for venue timezone
  • Custom Dates: Supports specific date selection via ISO 8601 format
  • Timezone Calculation: Automatic timezone offset based on venue country and state
  • Start-of-Day Alignment: Data aligned to venue local time boundaries

Access Control: Access is controlled through Cognito authentication with venue-specific permissions. Users can only access usage data for venues they are authorized to manage.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token for venue administrator access

VenueID
required
string

Primary venue identifier. Can be either the internal venue ID or an external venue ID from integrated systems. The system automatically resolves external venue IDs to internal references for data retrieval.

externalVenueID
string

Alternative external venue identifier used by integrated systems. When provided, this takes precedence over VenueID for venue identification. Supports mapping between external system IDs and internal venue references.

UsageReportStartDateUTC.ISO8601
string <date-time>

Optional specific date for usage report in ISO 8601 UTC format. When not provided, the system defaults to returning the previous day's usage data adjusted for the venue's local timezone.

Date Processing:

  • Automatically adjusts to venue timezone for start-of-day calculations
  • Supports both current and historical date selection
  • All timestamps are converted to venue local time for accurate reporting

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "UsageReportStartDateUTC.ISO8601": "2024-09-10T00:00:00.000Z"
}

Response samples

Content type
application/json
Example
{
  • "UsageData": [
    ],
  • "message": ""
}

/venuemgmtconsole/venues/configureVenue

Updates venue contact information including primary contact details and support configuration. This endpoint allows venue administrators to modify essential contact data with input validation, sanitization, and comprehensive audit logging.

Key Features:

  • Contact Management: Update primary contact person's given and family names (40 character max)
  • Support Configuration: Automatic support email derivation from primary contact email
  • Phone Validation: E.164 international formatting with country-specific validation
  • Partial Updates: Modify only specified fields without affecting other venue properties
  • Security Validation: HTML/XSS sanitization and input length restrictions

Input Processing:

  • Name Sanitization: HTML tags and entities stripped from name fields
  • Email Validation: RFC-compliant email address validation for primary contact
  • Phone Formatting: Automatic E.164 formatting based on venue country code
  • Length Limits: Contact names truncated to 40 characters maximum
  • Data Modification Tracking: Updates venue modification timestamp

Validation Rules:

  • PrimaryContactGivenName/FamilyName: HTML sanitization, 40 character limit, trim whitespace
  • PrimaryContactEmailAddress: Must pass validator.isEmail() validation
  • PrimaryContactPhoneNumber.E164: Minimum 8 characters, validated against country code
  • Support Fields: SupportEmailAddress auto-generated (lowercase), SupportPhoneNumber.E164 auto-formatted

Audit Logging:

  • Administrator Tracking: Records administrator email and access details
  • Source Information: IP address, browser, OS, and locale information
  • Change Events: Detailed log of all field modifications with before/after values
  • Timestamp Tracking: Updates venue modification timestamp and creates audit log entry

Data Flow:

  1. Input Validation: Sanitize and validate all provided contact fields
  2. Email Processing: Validate email format and set as support email (lowercase)
  3. Phone Processing: Validate and format phone number to E.164 standard
  4. Profile Update: Apply changes with modification timestamp
  5. Audit Creation: Generate comprehensive audit log with administrator and change details

Access is controlled through Cognito authentication with venue administrator permissions ensuring users can only modify venues they are authorized to manage.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator access token for authentication

VenueID
required
string

Unique identifier of the venue to configure

PrimaryContactGivenName
string <= 40 characters

Primary contact's first/given name (max 40 characters, HTML sanitized)

PrimaryContactFamilyName
string <= 40 characters

Primary contact's last/family name (max 40 characters, HTML sanitized)

PrimaryContactEmailAddress
string <email>

Primary contact's email address (becomes support email, RFC validated)

PrimaryContactPhoneNumber.E164
string

Primary contact's phone number (will be validated and formatted to E.164)

Country.ISO3166A3
string

Three-letter country code for phone number validation (defaults to 'USA')

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "PrimaryContactGivenName": "John",
  • "PrimaryContactFamilyName": "Smith",
  • "PrimaryContactEmailAddress": "john.smith@hotel.com",
  • "PrimaryContactPhoneNumber.E164": "+1-555-123-4567",
  • "Country.ISO3166A3": "USA"
}

Response samples

Content type
application/json
Example
{
  • "message": "PrimaryContactGivenName set to John. PrimaryContactFamilyName set to Smith. SupportEmailAddress set to john.smith@hotel.com. SupportPhoneNumber.E164 set to +15551234567."
}

/venuemgmtconsole/venue_units/listVenueUnitUsageData

Retrieves comprehensive daily bandwidth usage data and historical consumption patterns for a specific venue unit over the last 180 days. This endpoint provides detailed analytics for unit-level bandwidth monitoring and capacity planning.

Key Features:

  • 180-Day History: Complete daily bandwidth usage data for the past 180 days
  • Unit-Level Analytics: Specific usage data for individual venue units
  • External ID Support: Automatic resolution of external venue and unit IDs
  • Cached Data Access: High-performance retrieval from pre-aggregated daily summaries
  • Flexible Time Windows: Multi-hour timestamp tolerance for data availability

Usage Metrics Provided:

  • Input Octets: Daily downstream bandwidth consumption (subscriber downloads)
  • Output Octets: Daily upstream bandwidth consumption (subscriber uploads)
  • Total Octets: Combined daily bandwidth usage for comprehensive analysis
  • Reporting Timestamps: Daily reporting period timestamps for chronological analysis

Data Processing Flow:

  1. Venue/Unit Resolution: Supports external venue and unit ID mapping for integrated systems
  2. Access Validation: Ensures user has permission to access specified venue unit data
  3. Base Timestamp: Retrieves unit's daily bandwidth reporting timestamp as starting point
  4. Historical Retrieval: Loops through 180 days of cached daily bandwidth data
  5. Multi-Hour Tolerance: Attempts data retrieval with ±1 hour timestamp flexibility
  6. Data Processing: Aggregates Input/Output octets with negative value correction
  7. Chronological Assembly: Returns ordered array of daily usage reports

Cache Strategy:

  • Primary Lookup: Uses venue unit ID + daily timestamp for cache key
  • Fallback Logic: ±1 hour timestamp tolerance for data availability
  • Zero Handling: Returns zero values for days with no cached usage data
  • Performance Optimization: Single cache queries per day for efficient retrieval

Time Window Processing:

  • Base Period: Starts from unit's DailyBWReportDateTimeUTC.ISO8601 timestamp
  • Backwards Iteration: Retrieves data for previous 180 days from base timestamp
  • Timestamp Tolerance: ±1 hour flexibility to handle cache timing variations
  • Reporting Consistency: Each day returns consistent 24-hour usage aggregates

Access is controlled through Cognito authentication with venue-specific permissions ensuring users only access usage data for venue units they are authorized to manage.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
Any of
AccessToken
required
string

Valid Cognito access token for authentication and authorization

VenueID
required
string

Internal venue identifier (required for venue management console access)

externalVenueID
string

External venue identifier (alternative to VenueID for integration purposes)

UnitID_internal
required
string

Internal venue unit identifier for which usage data is requested

externalVenueUnitID
string

External venue unit identifier (alternative to UnitID_internal for integration)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "UnitID_internal": "venue_12345.UNIT101.BLDG1.FLOOR2"
}

Response samples

Content type
application/json
{
  • "message": "",
  • "UsageData": [
    ]
}

/venuemgmtconsole/venue_units/listVenueUnitLog

Retrieves comprehensive audit trail and activity logs for a specific venue unit, including administrative actions, configuration changes, and system events with chronological ordering and administrator identification.

Key Features:

  • Unit-Specific Audit Trail: Complete log of venue unit-related activities and operations
  • External ID Support: Automatic resolution of external venue and unit IDs for integration
  • Administrator Tracking: Enriched log entries with Cognito user profile information
  • Role-Based Filtering: Access-appropriate log filtering for venue administrators vs network operators
  • Chronological Ordering: Logs ordered by timestamp (newest first) with 100-entry limit

Unit Identification Methods:

  • Direct Access: Use UnitID_internal for direct unit identification
  • External Integration: Use externalVenueUnitID + VenueID/externalVenueID for integrated systems
  • Automatic Resolution: System resolves external IDs to internal unit references
  • Venue Association: Automatic venue ID determination when only unit ID provided

Log Categories:

  • Configuration Changes: Unit settings, service plan modifications, network updates
  • Administrative Actions: User management, access control changes, administrative operations
  • Subscriber Activities: Service activations, password resets, subscription management
  • System Events: Authentication attempts, connection logs, operational events

Filtering by Role:

  • Venue Administrators: Filtered logs excluding network equipment configuration and SIEM events
  • Network Operators: Complete system logs including all infrastructure-related events
  • Access Control: Only logs for venue units within operator's management scope

Data Processing Flow:

  1. ID Resolution: Supports external venue and unit ID mapping for integrated systems
  2. Venue Association: Automatic venue ID determination from unit relationships when needed
  3. Access Validation: Ensures user has permission to view specific unit logs
  4. Log Retrieval: Queries unit-specific log entries from audit database
  5. Role Filtering: Applies function-based filtering for venue administrators
  6. Chronological Sort: Orders by timestamp (descending) with recent 100 entries
  7. User Enrichment: Enhances logs with Cognito administrator profile details

Access is controlled through Cognito authentication with venue-specific permissions ensuring users only access logs for venue units they are authorized to manage.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid Cognito access token for authentication and authorization

VenueID
string

Internal venue identifier (optional if UnitID_internal is provided)

externalVenueID
string

External venue identifier for property management integration

UnitID_internal
string

Internal venue unit identifier for log retrieval

externalVenueUnitID
string

External venue unit identifier (requires VenueID or externalVenueID)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "UnitID_internal": "venue_12345.UNIT101.BLDG1.FLOOR2"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "UnitID_internal": "venue_12345.UNIT101.BLDG1.FLOOR2",
  • "log": [
    ]
}

/networkoperatorconsole/venues/listVenues

Get complete venue portfolio with operational status, performance metrics, and role-based access control. Returns venue identification, address details, contact info, unit/policy/device counts, daily report metrics, shopping cart configuration, and real-time online device status. Access level determines data visibility: network operators get full portfolio, venue administrators get assigned venues only, subscribers get personal usage stats, public access gets shopping-cart-enabled venues only.

Authorizations:
CognitoAuthNone
Request Body schema: application/json
required
AccessToken
required
string

Authentication token with appropriate access level for venue portfolio retrieval

VenueID
required
string

Venue identifier for API context (required for operator console endpoints)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJvcGVyYXRvcl8xMjMiLCJpYXQiOjE2ODQ1NjcxMjN9...",
  • "VenueID": "venue_hotel_downtown"
}

Response samples

Content type
application/json
Example
{
  • "errorProcessing": false,
  • "message": "Venue portfolio retrieved successfully",
  • "VenueCount": 3,
  • "VenueList": {
    }
}

/networkoperatorconsole/venues/addVenue

Create and register new venue with complete address validation and network integration. Requires address fields (VenueName, AddressLine1, City, State, Country ISO 3166 Alpha-3, PostalCode), supports optional AddressLine2/3. Network operator domain administrator access required.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token

VenueName
required
string

Descriptive name for the venue

AddressLine1
required
string

Primary address line (street number and name)

AddressLine2
string

Secondary address information (optional)

AddressLine3
string

Additional address details (optional)

City
required
string

City or municipality name

State
required
string

State, province, or administrative region

Country
required
string

ISO 3166 Alpha-3 country code

PostalCode
required
string

Postal or ZIP code

Country.ISO3166A3
string

Alternative country code field (mapped to Country)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueName": "Downtown Business Hotel",
  • "AddressLine1": "123 Main Street",
  • "City": "Chicago",
  • "State": "Illinois",
  • "Country": "USA",
  • "PostalCode": "60601"
}

Response samples

Content type
application/json
Example
{
  • "message": "Venue created successfully",
  • "VenueID": "venue_downtown_hotel_001",
  • "Address": {
    },
  • "NetworkConfiguration": {
    }
}

/networkoperatorconsole/venues/configureVenueEquipment

Configure venue network equipment settings including gateways and network infrastructure. Updates equipment parameters such as IP addresses, credentials, manufacturer settings, and operational status. Supports gateway configuration reset and ACL management for MikroTik devices.

Key Features:

  • Equipment Configuration - IP address, port, connection protocol, and authentication credentials
  • Manufacturer Support - Mikrotik, Nomadix, Peplink, RiQ
  • Status Management - Set equipment UP/DOWN status with automatic error counter reset
  • Gateway Reset - Reset all subscriptions at venue by clearing gatewayConfigured flags
  • ACL Management - Update MikroTik gateway ACLs with Vault API IP addresses

Equipment Types: Gateway equipment enforces a maximum limit of 3 gateways per venue.

Gateway Configuration Reset: When resetAllSubscriptions=true and equipment type is Gateway, all subscriptions at the venue have their gatewayConfigured properties removed, forcing reconfiguration on next scheduler cycle. This also resets gateway error counters.

ACL Update Process: When updateACL=true, updates MikroTik gateway firewall rules to allow incoming connections from Vault API servers. Environment-specific IP addresses are automatically selected based on deployment domain (wifikey.link, roamingiqtest.com, api.wifikey.io, apiaus.wifikey.io).

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Authentication token for network operator access - requires NetworkOperator or NetworkSoftwareProvider role

VenueID
required
string [ 5 .. 100 ] characters

Internal Vault venue identifier where equipment is located

EquipmentID
required
string [ 5 .. 100 ] characters

Unique identifier for the network equipment to configure

Manufacturer
string
Enum: "MikroTik" "Mikrotik" "Nomadix" "Peplink" "PepLink" "RiQ"

Equipment manufacturer - MikroTik, Nomadix, Peplink, or RiQ

Model
string <= 40 characters

Equipment model designation - sanitized and limited to 40 characters

EquipmentType
string <= 20 characters

Equipment classification - Gateway type enforces 3 gateway per venue limit. Change requires VenueEquipmentUpdater role if equipment already configured.

WirelessZone
string <= 40 characters

Wireless network zone designation - sanitized and limited to 40 characters

MikrotikPre643
boolean

Flag indicating MikroTik RouterOS version prior to 6.43 (affects API communication protocol)

ConnectionProtocol
string
Enum: "http" "https"

Communication protocol for equipment API access

IPAddress
string <ipv4>

Equipment IPv4 or IPv6 address - validated with validator.isIP()

Port
string^[0-9]{1,5}$

Equipment API port number - validated with validator.isPort()

Username
string <= 64 characters

Equipment authentication username - sanitized and limited to 64 characters

Password
string <password> <= 100 characters

Equipment authentication password - sanitized and limited to 100 characters. Not returned in audit logs.

Status
string
Enum: "UP" "DOWN"

Equipment operational status - setting to UP resets gateway error counters

resetAllSubscriptions
boolean

When true and equipment is a Gateway, removes gatewayConfigured properties from all venue subscriptions and payment intents, forcing reconfiguration. Also resets gateway error counters.

updateACL
boolean

Update MikroTik gateway ACL to allow connections from Vault API servers. Automatically selects environment-specific IP addresses.

Responses

Request samples

Content type
application/json
Example

Update MikroTik gateway settings and refresh ACL rules

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_abc123",
  • "EquipmentID": "gw_mikrotik_001",
  • "Manufacturer": "MikroTik",
  • "Model": "RB4011iGS+5HacQ2HnD-IN",
  • "EquipmentType": "Gateway",
  • "ConnectionProtocol": "https",
  • "IPAddress": "192.168.1.1",
  • "Port": "8728",
  • "Username": "admin",
  • "Password": "SecurePassword123",
  • "MikrotikPre643": false,
  • "Status": "UP",
  • "updateACL": true
}

Response samples

Content type
application/json
Example
{
  • "message": "Updated Manufacturer = MikroTik. Updated Model = RB4011iGS+5HacQ2HnD-IN. Updated IPAddress to 192.168.1.1. Updated Port to 8728. Updating Status to UP. Updated ACL. ",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "update_acl": {
    }
}

/networkoperatorconsole/venues/listVenueUnits

Retrieve all units within a venue with complete configuration data including unit identification (UnitID_internal, UnitID, externalVenueUnitID), address details (AddressLine1/2, City, State, PostalCode, Country ISO 3166 Alpha-3), building/floor information, unit classification (purpose type), and SMS codes. Supports querying by VenueID or externalVenueID. Returns VenueUnitCount and VenueUnits array with comprehensive unit details.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Authentication token for network operator access

VenueID
string

Internal Vault venue identifier for unit retrieval

externalVenueID
string

External property management system venue identifier

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "VenueID": "venue_12345",
  • "externalVenueID": "PMS_VENUE_001"
}

Response samples

Content type
application/json
{
  • "VenueUnitCount": 2,
  • "VenueUnits": [
    ],
  • "dateUpdated": "2025-09-12T10:45:23.456Z"
}

/networkoperatorconsole/venues/addVenueUnits

Add venue unit to venue with automatic VLAN generation and configuration. Creates venue_unit vertices in Neptune with address validation, purpose-based VLAN assignment, and webhook notifications. This endpoint uses a regional proxy pattern where requests are validated locally and forwarded to the primary region for execution.

Architecture Pattern:

  • Regional Proxy - Deployed in all AWS regions (us-east-1, us-west-2, eu-west-1)
  • Local Validation - JWT token validation and input checks performed in user's region
  • Primary Region Execution - Business logic executed in us-east-1 with authoritative Neptune database
  • Cross-Region Forwarding - Authenticated requests forwarded to primary region gremlinconsole Venue.addUnit operation

Access Control - Role Hierarchy:

  • Domain Administrator - Full venue unit management for all venues within their operator
  • Network Software Provider - Multi-operator unit creation with explicit OperatorID parameter

Required Parameters:

  • AccessToken - JWT token with Domain Administrator or Network Software Provider role
  • VenueID - Target venue identifier (or externalVenueID for venue resolution)
  • UnitID - Unit identifier (auto-generated from AddressLine1/AddressLine2 if not provided)

Execution Flow:

  1. Field Mapping - Transform client field names to internal API format using configureVenueUnit mapping
  2. Redis Connection - Establish connection to regional Redis cluster for session management
  3. Input Validation - Validate request structure, AccessToken presence, JWT signature
  4. Role-Based Access Control - Verify user has Domain Administrator or Network Software Provider role
  5. Required Field Validation - Verify UnitID present in request body
  6. Cross-Region Forward - POST to primary region gremlinconsole Venue.addUnit operation
  7. Response Handling - Return sanitized response to API Gateway
  8. Error Notification - On uncaught exceptions, email development team with stack trace

Business Logic (Venue.addUnit in Primary Region):

  1. Access Control - Verify operator codebranch write access
  2. Venue Resolution - Resolve venue by VenueID or externalVenueID
  3. Location Validation - Validate country (ISO 3166 Alpha-3), state, postal code using i18n-iso-countries and locations database
  4. UnitID Generation - Auto-generate UnitID from AddressLine1/AddressLine2 if not provided (first and last word concatenated with hyphen)
  5. UnitID_internal Construction - Build internal identifier: VenueID.UnitID.Building.Floor (each component normalized to 20 chars, uppercase, alphanumeric/underscore/hyphen only)
  6. VLAN Auto-Generation - Assign VLAN from venue/operator ranges based on purpose type (automatic for venues with <200 units)
  7. Unit Creation - Create venue_unit vertex with address, VLAN, ShoppingCartPriceAdjustment=0, and venue_has_unit relationship
  8. Audit Logging - Log unit addition to Neptune log vertex with operator, venue, unit, VLAN details
  9. Webhook Notification - Send VenueUnitAdded webhook event (if WebhookURL configured)
  10. Additional Configuration - Call configureUnit for extended configuration

VLAN Auto-Generation Algorithm:

  • Applies When: Unit count < 200 at venue (manual VLAN required for 200+ units)
  • Purpose-Based Ranges:
    • wiredunit: MinimumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess to MaximumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess
    • localwirelessonly: MinimumAutoGeneratedVLAN_LocalWirelessAccess to MaximumAutoGeneratedVLAN_LocalWirelessAccess
    • globalroaming: Uses venue/operator VLAN ranges (similar to wiredunit)
  • Iteration Strategy: Start at minimum VLAN, check availability with Neptune query, assign first unassigned VLAN
  • Fallback: Uses venue VLAN ranges if operator ranges not configured
  • Validation: VLAN must be between 1-4095 (valid VLAN range)

UnitID_internal Construction:

  • Format: VenueID.UnitID.Building.Floor
  • Normalization Per Component:
    • Truncate to 20 characters
    • Remove special characters (only alphanumeric, underscore, hyphen allowed)
    • Convert to uppercase
  • Example: venue_123.UNIT-101.BUILDING-A.FLOOR-3
  • Usage: Unique identifier used as Neptune vertex ID

Location Data Hierarchy:

  1. Request Body Values - If provided and valid, use request values
  2. Venue Values - If request values missing or invalid, inherit from venue
  3. Default Values - Country: 'USA', Building: 'DEFAULT', Floor: 'DEFAULT'

Unit Purpose Types:

  • wiredunit - Global wireless + local wired access (default, uses GlobalWirelessPlusLocalWiredAccess VLAN range)
  • localwirelessonly - Local wireless access only, no roaming (uses LocalWirelessAccess VLAN range)
  • globalroaming - Global wireless roaming without local wired (uses GlobalWirelessRoaming VLAN range)

Validation Rules:

  • VenueID: Required, must exist in Neptune, cannot be 'global'
  • UnitID: Auto-generated from AddressLine1/AddressLine2 if not provided, 20 char max, HTML sanitized
  • Country: ISO 3166 Alpha-3 code (USA, CAN, etc.), validated with i18n-iso-countries library
  • State: Validated against locations database for selected country (abbreviation or full name accepted)
  • PostalCode: Validated with validator.isPostalCode for any country format
  • VLAN: Between 1-4095, auto-generated if not provided (for venues with <200 units)
  • UnitBuilding/UnitFloor: Defaults to 'DEFAULT' if not provided, 20 char max, HTML sanitized
  • Address Fields: 40 char max for AddressLine1/AddressLine2, City; 10 char max for PostalCode

Error Scenarios:

  • 401: AccessToken missing or invalid
  • 401: Access denied (insufficient role permissions)
  • 401: OperatorID missing (Network Software Provider role)
  • 401: Invalid VenueID, VenueID not found, or VenueID is 'global'
  • 401: Invalid Country or State for selected country
  • 401: PostalCode validation failed
  • 401: UnitID could not be generated from AddressLine1/AddressLine2
  • 401: VLAN must be between 1-4095
  • 401: VLAN must be provided when adding more than 200 units
  • 401: Auto-generated VLAN not available (all VLANs in range assigned)
  • 401: Write access not permitted on codebranch (regional restriction)
  • 401: Contact support to add more units (venue unit count >= 5000)
  • 401: Server busy (primary region connection failure)

Response Handling:

  • New Unit: Returns "Unit added." with UnitID_internal, UnitID, vlan
  • Existing Unit: Returns "Updating pre-existing unit." with configuration results
  • Errors: Returns errorProcessing: true, statusCode, message
  • Sanitization: Response always sanitized before returning to client

Performance Characteristics:

  • Local Validation: <50ms (JWT validation, input checks in user's region)
  • Cross-Region Latency: 20-100ms (varies by region to us-east-1)
  • Business Logic Execution: 200-500ms (Neptune queries, VLAN iteration)
  • Total End-to-End: 300-700ms typical
  • Neptune Queries: 4-6 queries (codebranch, venue, operator VLAN, unit count, VLAN availability, unit creation)
  • VLAN Iteration: O(n) where n = (max_vlan - min_vlan), worst case when all VLANs assigned
  • Consistency Delays: 30ms after unit creation (Neptune), 30ms after webhook (notification processing)

Integration Points:

  • Redis - Regional cluster for session management and JWT validation
  • Cognito - JWT token validation (CognitoPool from operator configuration)
  • Neptune (g_r, g_w) - Query venue/operator data, create venue_unit vertex, establish venue_has_unit relationship
  • Neptune (li_w) - Create log vertex for audit trail with operator, venue, unit details
  • Field Mapping - configureVenueUnit transformation for request body
  • NotificationEngine - Send VenueUnitAdded webhook event, email alerts to development team
  • configureUnit - Additional unit configuration (RealPage integration, unit updates)

Webhook Event:

  • Type: VenueUnitAdded
  • Payload: Complete venue_unit vertex data (VenueID, UnitID_internal, UnitID, vlan, address, purpose, etc.)
  • Condition: Only sent if WebhookURL configured for operator
  • Timing: Sent after unit creation, before configureUnit call

Features:

  • Automatic VLAN Generation - Purpose-based VLAN assignment from venue/operator ranges
  • UnitID Auto-Generation - Generate from AddressLine1/AddressLine2 if not provided
  • Address Inheritance - Inherit location data from venue if not provided
  • Location Validation - Country (ISO 3166), state, postal code validation
  • Update Existing Units - If unit exists, performs configuration update via configureUnit
  • Multi-Operator Support - Network Software Provider role with explicit OperatorID
  • External Venue Resolution - Support for externalVenueID lookup
  • Audit Trail - Complete logging with operator, venue, unit, VLAN details
  • Webhook Notifications - VenueUnitAdded event with complete unit data
  • Regional Proxy - Low-latency authentication in user's region
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

VenueID
required
string

Target venue identifier for unit creation (supports external venue ID lookup)

externalVenueID
string

External venue identifier for property management system integration

UnitID
required
string

Unique unit identifier (auto-generated from address if not provided)

UnitBuilding
required
string

Building designation within venue complex (required, max 20 chars, defaults to 'DEFAULT')

UnitFloor
required
string

Floor or level designation (required, max 20 chars, defaults to 'DEFAULT')

AddressLine1
string

Primary unit address (inherits from venue if not provided)

AddressLine2
string

Secondary address information (optional unit-specific details)

City
string

Municipality designation (inherits from venue if not provided)

State
string

State or province identifier (inherits from venue if not provided)

PostalCode
string

Postal or ZIP code (inherits from venue if not provided)

Country.ISO3166A3
string

ISO 3166 Alpha-3 country code (inherits from venue if not provided)

purpose
string
Default: "wiredunit"
Enum: "wiredunit" "localwirelessonly" "globalroaming"

Unit type classification for network access configuration

vlan
integer [ 1 .. 4095 ]

Optional VLAN assignment (auto-generated if not provided, range 1-4095)

PrimaryUnitID_internal
string

Internal primary unit identifier for unit relationships

PrimaryUnitID
string

Primary unit identifier for unit management

RealPageUnitID
integer

RealPage property management system unit identifier

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJvcGVyYXRvcl8xMjMiLCJpYXQiOjE2ODQ1NjcxMjN9...",
  • "VenueID": "venue_hotel_downtown._V3VENUE.12345",
  • "UnitID": "101",
  • "UnitBuilding": "Building-A",
  • "UnitFloor": "1",
  • "AddressLine1": "123 Hotel Plaza Drive, Unit 101",
  • "AddressLine2": "Suite 101",
  • "City": "Downtown",
  • "State": "CA",
  • "PostalCode": "90210",
  • "Country.ISO3166A3": "USA",
  • "purpose": "wiredunit"
}

Response samples

Content type
application/json
Example
{
  • "errorProcessing": false,
  • "message": "Unit added.",
  • "UnitID_internal": "venue_hotel_downtown._V3VENUE.12345.101.BUILDING-A.1",
  • "VenueID": "venue_hotel_downtown._V3VENUE.12345",
  • "vlan": 101
}

/networkoperatorconsole/venues/updateVenueAddress

Update venue physical address and location details including street addresses (AddressLine1/2 max 40 chars), city, postal code, and geographic coordinates. Address updates synchronized across all related venue units, subscriptions, and payment records. Validates address uniqueness within operator's venue portfolio. Uses configureVenue implementation. Domain administrator access required.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrative access token with NetworkOperator domain administrator privileges required for venue address modifications

VenueID
required
string

Unique identifier of the venue whose address information will be updated. Must be a venue within the operator's managed portfolio.

VenueName
string <= 40 characters

Updated venue name or location identifier. Limited to 40 characters and sanitized to remove HTML tags and special characters.

AddressLine1
string <= 40 characters

Primary street address line including building number and street name. Sanitized input limited to 40 characters.

AddressLine2
string <= 40 characters

Secondary address line for suite, apartment, or unit details. Optional field that can be removed by sending a single space character. Limited to 40 characters.

City
string <= 40 characters

City or municipality name for the venue location. HTML tags and special characters are sanitized. Limited to 40 characters.

PostalCode
string

Postal or ZIP code for the venue address. Validated using international postal code formats to ensure accuracy.

externalVenueID
string <= 64 characters

External system identifier for venue integration with third-party management platforms. Can be removed by sending a single space character. Limited to 64 characters.

Responses

Request samples

Content type
application/json
Example

Update all address components for a venue location

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345678-90ab-cdef-1234-567890abcdef",
  • "VenueName": "Downtown Business Center",
  • "AddressLine1": "123 Main Street",
  • "AddressLine2": "Suite 100",
  • "City": "New York",
  • "PostalCode": "10001",
  • "externalVenueID": "EXT_VENUE_001"
}

Response samples

Content type
application/json

Address components successfully updated with audit details

{
  • "message": "Updated VenueName = Downtown Business Center. Updated AddressLine1 = 123 Main Street. Updated City = New York. Updated PostalCode = 10001.",
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/venues/addConnectWiseCredentials

Configure ConnectWise PSA integration for automated ticketing and service management. Requires URL (HTTPS required), Authorization token, optional serviceboardid for ticket routing, ClientID for API authentication, and CompanyID for venue mapping. Enables automatic support ticket creation and company tracking. Domain administrator access required. Uses configureVenue implementation with field mapping support for legacy compatibility.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Domain administrator access token with venue configuration privileges

VenueID
required
string

Unique venue identifier for ConnectWise integration setup

URL
required
string <uri>

ConnectWise PSA server URL (HTTPS required)

Authorization
required
string

ConnectWise API authorization token for PSA system access

serviceboardid
string

ConnectWise service board identifier for ticket routing

ClientID
string

ConnectWise client identifier for API authentication

CompanyID
string

ConnectWise company record identifier for venue mapping

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "USA.CA.90210.HOSPITALITY.BEVERLYHILLS._V3VENUE_.USA.CA.90210.LUXURYHOTEL.BEVERLYHILLS",
  • "URL": "https://api-na.myconnectwise.net",
  • "Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
  • "serviceboardid": "Support Board",
  • "ClientID": "MyCompanyIntegration",
  • "CompanyID": "LUXURYHOTEL"
}

Response samples

Content type
application/json
{
  • "message": "ConnectWise PSA integration configured successfully. Service board mapped to Support Board.",
  • "errorProcessing": false,
  • "VenueID": "USA.CA.90210.HOSPITALITY.BEVERLYHILLS._V3VENUE_.USA.CA.90210.LUXURYHOTEL.BEVERLYHILLS"
}

/networkoperatorconsole/venues/addPRTGCredentials

Configure PRTG (Paessler Router Traffic Grapher) monitoring system integration for venue-specific network equipment monitoring.

⚠️ Deprecated: Sunset date 2040-12-30.

Required Parameters:

  • AccessToken - Network operator authentication (domain administrator privileges)
  • PRTG Server URL - PRTG server endpoint
  • Username - PRTG authentication username
  • Password Hash - Encrypted password
  • Group Configuration - PRTG group settings

Monitoring Capabilities:

  • Wireless controllers
  • CMTS systems
  • OLT devices
  • G.hn headend equipment

Features:

  • Real-time status tracking (UP/DOWN/UNUSUAL)
  • Performance metrics collection
  • Automated alerting
  • Multiple PRTG servers support
  • Encrypted credential storage
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

VenueID
required
string

Unique venue identifier for PRTG integration configuration

required
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "Integrations": {}
}

Response samples

Content type
application/json
{
  • "message": "PRTG monitoring integration configured successfully",
  • "VenueID": "venue_12345",
  • "monitoring_status": "enabled",
  • "integration_details": {}
}

/networkoperatorconsole/venues/enableServicePlan

Activate service plan for subscriber access at venue by establishing service plan-venue association. Validates service plan and venue existence within operator portfolio, prevents duplicate associations, and automatically syncs to backup systems. Supports domain administrator, account manager, and customer support access roles. Enables subscriber provisioning, service discovery, and self-service plan selection. Cache automatically updated for service plan availability queries. Network operator authentication required.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Authentication token for network operator access

ServicePlanID
required
string

Service plan identifier to activate at venue

VenueID
required
string

Venue identifier where service plan will be enabled

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "ServicePlanID": "plan_12345",
  • "VenueID": "venue_67890"
}

Response samples

Content type
application/json
{
  • "ServicePlanID": "plan_12345",
  • "VenueID": "venue_67890",
  • "message": "Service plan Premium WiFi enabled for Downtown Hotel"
}

/networkoperatorconsole/venues/disableServicePlan

Remove service plan from venue offerings, preventing new subscriber selections while maintaining existing active subscriptions. Validates operator ownership and creates audit trail. Network operator authentication required.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token

VenueID
required
string

Unique identifier of the venue where the service plan should be disabled

ServicePlanID
required
string

Unique identifier of the service plan to disable at the venue

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "VenueID": "string",
  • "ServicePlanID": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "ServicePlanID": "string"
}

/networkoperatorconsole/admin/deleteVenuePermanently

⚠️ CRITICAL WARNING: This operation cannot be undone and permanently removes ALL venue data including property information, tenant records, staff assignments, network configurations, subscriber accounts, and historical analytics.

Required Parameters:

  • AccessToken - Network operator authentication with administrative deletion privileges
  • VenueID - Target venue identifier
  • DeletionReason - Business justification: BusinessClosure, ContractTermination, DataMigration, RegulatoryCompliance, or SecurityIncident
  • ConfirmationCode - Security code (format: DELETE-VENUE-XXXX)
  • DataRetentionCompliance - Confirmation that deletion meets regulatory requirements

Optional Parameters:

  • ScheduledDeletionDate - Schedule deletion for specific date/time
  • DataExportRequired - Request data export before deletion
  • NotificationPreferences - Stakeholder notifications (email/sms/both), include audit report
  • AuditDocumentation - Additional compliance documentation

Data Deleted: Units, staff, subscribers, equipment, billing history, usage analytics, operational logs, network configurations.

Process: Multiple confirmation steps, complete audit trail, optional scheduled deletion with stakeholder notifications.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative deletion privileges

VenueID
required
string

Target venue identifier for permanent deletion

DeletionReason
required
string
Enum: "BusinessClosure" "ContractTermination" "DataMigration" "RegulatoryCompliance" "SecurityIncident"

Business justification for venue deletion

ConfirmationCode
required
string^DELETE-VENUE-[A-Z0-9]{4}$

Security confirmation code to verify intentional deletion (format: DELETE-VENUE-XXXX)

DataRetentionCompliance
required
boolean

Confirmation that data deletion meets regulatory compliance requirements

ScheduledDeletionDate
string <date-time>

Optional scheduled deletion date for planned business operations

DataExportRequired
boolean

Request data export before deletion for business continuity

object
AuditDocumentation
string

Additional compliance documentation and business justification

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "VENUE_12345",
  • "DeletionReason": "BusinessClosure",
  • "ConfirmationCode": "DELETE-VENUE-A1B2",
  • "DataRetentionCompliance": true,
  • "NotificationPreferences": {
    },
  • "AuditDocumentation": "Property closure due to end of lease agreement - Legal Case #LG-2024-001"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "deletionId": "DEL_987654321",
  • "venue": {
    },
  • "deletedData": {
    },
  • "audit": {
    },
  • "notifications": {
    }
}

/networkoperatorconsole/admin/deleteAllVenueUnitsPermanently

⚠️ WARNING: This removes ALL units and tenant data from the venue permanently while preserving venue infrastructure.

Required Parameters:

  • AccessToken - Network operator authentication with administrative deletion privileges
  • VenueID - Target venue identifier
  • DeletionReason - PropertyRenovation, PortfolioRestructuring, SystemMigration, RegulatoryCompliance, or BusinessConversion
  • ConfirmationCode - Security code (format: DELETE-UNITS-XXXX)
  • UnitCountConfirmation - Exact number of units being deleted for verification

Optional Parameters:

  • PreserveTenantData - Option to preserve tenant data
  • ScheduledDeletionDate - Schedule deletion for specific date/time
  • DataExportRequired - Request data export before deletion
  • NotificationPreferences - Tenant/stakeholder notifications (email/sms/both)

Removes: All residential/commercial unit records, tenant profiles, unit-specific equipment, billing history, usage analytics.

Preserves: Venue infrastructure, core network equipment, venue staff access.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative deletion privileges

VenueID
required
string

Target venue identifier for bulk unit deletion

DeletionReason
required
string
Enum: "PropertyRenovation" "PortfolioRestructuring" "SystemMigration" "RegulatoryCompliance" "BusinessConversion"

Business justification for bulk unit deletion

ConfirmationCode
required
string^DELETE-UNITS-[A-Z0-9]{4}$

Security confirmation code to verify intentional bulk deletion (format: DELETE-UNITS-XXXX)

UnitCountConfirmation
required
integer >= 1

Exact number of units being deleted for verification

PreserveTenantData
boolean
Default: false

Option to preserve tenant data for business continuity

ScheduledDeletionDate
string <date-time>

Optional scheduled deletion date for planned operations

DataExportRequired
boolean

Request data export before deletion for historical records

object
AuditDocumentation
string

Additional compliance documentation and business justification

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "VENUE_12345",
  • "DeletionReason": "PropertyRenovation",
  • "ConfirmationCode": "DELETE-UNITS-C3D4",
  • "UnitCountConfirmation": 150,
  • "DataExportRequired": true,
  • "NotificationPreferences": {
    },
  • "AuditDocumentation": "Property renovation project requiring complete unit reconfiguration - Project #REN-2024-003"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "deletionId": "BULK_DEL_456789123",
  • "venue": {
    },
  • "deletionSummary": {
    },
  • "dataExport": {
    },
  • "audit": {
    },
  • "notifications": {
    }
}

/networkoperatorconsole/admin/deleteVenueUnitPermanently

Permanently delete specific unit and all tenant data while preserving venue and other units.

Required Parameters:

  • AccessToken - Network operator authentication with administrative deletion privileges
  • VenueID - Parent venue identifier
  • UnitID - Specific unit identifier for targeted deletion
  • DeletionReason - TenantMoveOut, UnitRenovation, PropertyRestructuring, RegulatoryCompliance, or EquipmentFailure
  • ConfirmationCode - Security code (format: DELETE-UNIT-XXXX)

Optional Parameters:

  • PreserveTenantData - Option to preserve tenant data for business continuity
  • ScheduledDeletionDate - Schedule deletion for specific date/time
  • DataExportRequired - Request data export before deletion
  • NotificationPreferences - Tenant/venue manager notifications (email/sms/both)

Removes: Unit profile, tenant records, unit-specific network devices, billing history, usage analytics, support tickets.

Preserves: Venue infrastructure, other units, venue staff settings, shared network equipment.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative deletion privileges

VenueID
required
string

Parent venue identifier containing the target unit

UnitID
required
string

Specific unit identifier for targeted deletion

DeletionReason
required
string
Enum: "TenantMoveOut" "UnitRenovation" "PropertyRestructuring" "RegulatoryCompliance" "EquipmentFailure"

Business justification for unit deletion

ConfirmationCode
required
string^DELETE-UNIT-[A-Z0-9]{4}$

Security confirmation code to verify intentional unit deletion (format: DELETE-UNIT-XXXX)

PreserveTenantData
boolean
Default: false

Option to preserve tenant data for business continuity

ScheduledDeletionDate
string <date-time>

Optional scheduled deletion date for planned operations

DataExportRequired
boolean

Request data export before deletion for historical records

object
AuditDocumentation
string

Additional compliance documentation and business justification

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "VENUE_12345",
  • "UnitID": "UNIT_A101",
  • "DeletionReason": "TenantMoveOut",
  • "ConfirmationCode": "DELETE-UNIT-E5F6",
  • "DataExportRequired": true,
  • "NotificationPreferences": {
    },
  • "AuditDocumentation": "Tenant move-out completed - Unit A101 ready for renovation project REN-2025-004"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "deletionId": "UNIT_DEL_123456789",
  • "unit": {
    },
  • "deletedData": {
    },
  • "dataExport": {
    },
  • "audit": {
    },
  • "notifications": {
    }
}

/venuemgmtconsole/subscribers/resendCodeforTandC

Resend Terms & Conditions notifications to subscribers who completed setup intent but need communications resent through preferred channel.

Required Parameters:

  • AccessToken - Venue administrator authentication
  • VenueID - Venue context
  • One of: EmailAddress, PhoneNumber, or SubscriberToken for subscriber identification

Optional Parameters:

  • NotificationChannel - Delivery method: email or sms (auto-selected if not specified)

Core Functionality:

  • Multi-Channel Delivery - Email and SMS support with operator branding
  • Venue Validation - Ensures valid subscription setup intent at specified venue
  • Delayed Billing Support - Specifically for subscribers with delayed billing arrangements
  • Channel Selection - Automatic or manual with smart priority based on preferences
  • Access Control - Venue administrator with operator relationship verification

Returns: Success confirmation with delivery status.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
One of
AccessToken
required
string

Cognito authentication token for venue administrator with network operator permissions

VenueID
required
string

Unique venue identifier where the subscriber has a setup intent with delayed billing

EmailAddress
required
string <email>

Subscriber email address for identification (one identification method required)

PhoneNumber
string

Subscriber phone number for identification (one identification method required)

SubscriberToken
string

Internal subscriber token for direct identification (one identification method required)

NotificationChannel
string
Enum: "email" "sms"

Preferred notification delivery method for Terms & Conditions communication

Responses

Request samples

Content type
application/json
Example

Venue administrator resending Terms & Conditions email using subscriber email

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "EmailAddress": "guest@grandhotel.com"
}

Response samples

Content type
application/json
Example

Terms & Conditions email delivered successfully

{
  • "message": "",
  • "errorProcessing": false
}

/networkoperatorconsole/venues/listPropertyManagementGroups

Retrieve connected property management organizations for network operators.

Required Parameters:

  • AccessToken - Cognito network operator authentication

Processing:

  • Access Validation - Cognito token verification
  • Connection Query - Retrieve property management groups via database relationships
  • Data Population - Contact details and addresses from operator configuration
  • Response Compilation - Formatted list with connection metadata

Returns:

  • PropertyManagementGroupsCount - Total number of connected groups
  • PropertyManagementGroups - Object indexed by ID containing name, address (inherited from operator), email, management URL (auto-generated from operator domain), phone, connection metadata

Use Cases: Business development, partnership management, operational coordination between property managers and network operators.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator authentication token

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "PropertyManagementGroups": {
    },
  • "PropertyManagementGroupsCount": 3,
  • "message": ""
}

Subscribers

👥 Subscriber Database & Management

Complete subscriber database management system for tracking, monitoring, and administering all subscriber accounts and services.

Subscriber Database

  • 📋 Account Registry: Comprehensive subscriber information and service history
  • 🔍 Search & Filtering: Advanced search capabilities with multi-criteria filtering
  • 📊 Bulk Operations: Mass updates, imports, and data management tools
  • 📈 Analytics Engine: Subscriber behavior, churn analysis, and lifecycle tracking
  • 🔄 Data Synchronization: External system integration and data consistency
  • 📋 Compliance Management: Data privacy, retention policies, and audit trails

Management Tools

  • 👤 Profile Management: Detailed subscriber profiles and service configurations
  • 💳 Financial Overview: Payment history, billing status, and revenue tracking
  • 🎯 Segmentation: Customer segmentation for targeted communications and offers
  • 📊 Reporting Suite: Comprehensive subscriber analytics and business intelligence

/venuemgmtconsole/subscribers/validateEmailAddress

Check if email exists in Cognito user pool and retrieve subscriber profile including name, phone, locale, and subscriber token. Returns consistent response structure with defaults for missing attributes.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Cognito access token for authentication. Must belong to a user with venue administration privileges.

EmailAddress
required
string <email>

Email address to validate and lookup in the subscriber database. Email will be normalized to lowercase for consistent matching.

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "EmailAddress": "subscriber@example.com"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "GivenName": "John",
  • "FamilyName": "Smith",
  • "PhoneNumber.E164": "+15551234567",
  • "locale": "en-us",
  • "contactpref_sms": true,
  • "contactpref_email": true
}

/venuemgmtconsole/subscribers/addSubscriber

Create new subscriber accounts with WiFi access provisioning and billing configuration.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
EmailAddress
required
string <email>

Valid email address for subscriber account creation and notifications

UnitID_internal
required
string

Internal unit identifier for venue network access

VenueID
string

Venue identifier for location-based access

SubscriberToken
string

Existing subscriber token for account updates (optional for new subscribers)

UserPartForNewKey
string [ 1 .. 40 ] characters

Custom part of Wi-Fi password (1-40 characters, WPA-compatible)

NewKey
string [ 8 .. 63 ] characters

Legacy Wi-Fi password for existing network credentials (8-63 characters, WPA-compatible)

contactpref_email
boolean

Email communication preference for notifications and updates

contactpref_sms
boolean

SMS communication preference for notifications and alerts

externalSubscriberID
string

External system subscriber identifier for integration purposes

externalSubscriptionID
string

External system subscription identifier for billing integration

StartDateTimeUTC.ISO8601
string <date-time>

Subscription start date and time in ISO 8601 format

EndDateTimeUTC.ISO8601
string <date-time>

Subscription end date and time in ISO 8601 format

InvoiceDateTimeUTC.ISO8601
string <date-time>

Invoice date for billing purposes, sets trial cycles to 0

Responses

Request samples

Content type
application/json
{
  • "EmailAddress": "john.doe@example.com",
  • "UnitID_internal": "unit_12345",
  • "VenueID": "venue_67890",
  • "SubscriberToken": "subscriber_token_abc123",
  • "UserPartForNewKey": "mypassword123",
  • "NewKey": "legacypass12345",
  • "contactpref_email": true,
  • "contactpref_sms": false,
  • "externalSubscriberID": "ext_sub_789",
  • "externalSubscriptionID": "ext_subscription_456",
  • "StartDateTimeUTC.ISO8601": "2024-01-15T10:00:00.000Z",
  • "EndDateTimeUTC.ISO8601": "2024-12-31T23:59:59.000Z",
  • "InvoiceDateTimeUTC.ISO8601": "2024-01-15T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "SubscriberToken": "subscriber_abc123def456",
  • "EmailAddress": "john.doe@example.com",
  • "Status": "AUP not accepted",
  • "TemporaryPassword": "TempPass123",
  • "StripeCustomerID": "cus_stripe123456",
  • "contactpref_email": true,
  • "contactpref_sms": false,
  • "externalSubscriberID": "ext_sub_789"
}

/venuemgmtconsole/subscribers/confirmSubscriptionEnd

Finalize subscription termination for specific venue unit and date range. Validates subscriber via Cognito, performs timezone calculations, and marks matching policies as confirmed for termination.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
UnitID_internal
required
string

Internal venue unit identifier for subscription policy matching

VenueID
required
string

Venue identifier for policy location validation

EmailAddress
required
string <email>

Subscriber email address for Cognito user identification

StartDateTimeUTC.ISO8601
required
string <date-time>

Subscription start date for policy matching (timezone-adjusted)

EndDateTimeUTC.ISO8601
required
string <date-time>

Subscription end date for policy matching (timezone-adjusted)

UserTimeZone
integer

Browser timezone offset in minutes for date adjustment calculations

Responses

Request samples

Content type
application/json
{
  • "UnitID_internal": "unit_12345",
  • "VenueID": "venue_67890",
  • "EmailAddress": "john.doe@example.com",
  • "StartDateTimeUTC.ISO8601": "2024-01-15T10:00:00.000Z",
  • "EndDateTimeUTC.ISO8601": "2024-12-31T23:59:59.000Z",
  • "UserTimeZone": -300
}

Response samples

Content type
application/json
{
  • "GivenName": "John",
  • "FamilyName": "Doe",
  • "PhoneNumber.E164": "+1234567890",
  • "ConfirmedEndDate.ISO8601": "2024-01-15T14:30:45.123Z",
  • "message": ""
}

/venuemgmtconsole/subscribers/listMessages

Get communication history for subscriber including venue admin messages. Returns message history with subjects, content, delivery timestamps, and acknowledgment status.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
EmailAddress
required
string <email>

Subscriber email address for Cognito user identification and message lookup

VenueID
required
string

Venue identifier for filtering venue-specific messages

Responses

Request samples

Content type
application/json
{
  • "EmailAddress": "john.doe@example.com",
  • "VenueID": "venue_67890"
}

Response samples

Content type
application/json
{
  • "messages": {
    },
  • "message": ""
}

/venuemgmtconsole/subscribers/listSessions

Retrieve hourly usage session data and bandwidth statistics for past 7 days. Includes device connections, signal strength (RSSI), and venue/key pool filtering. Supports lookup by email or subscriber token.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
EmailAddress
required
string <email>

Subscriber email address for Cognito user identification and session lookup

SubscriberToken
string

Direct subscriber token for session data retrieval (alternative to email)

PhoneNumber.E164
string

Subscriber phone number in E.164 format for identification

VenueID
string

Filter sessions for specific venue location

KeyID
string

Filter sessions for specific key pool or PSK identifier

Calling-Station-Id
string

MAC address of specific device to filter sessions (accepts various formats)

Responses

Request samples

Content type
application/json
{
  • "EmailAddress": "john.doe@example.com",
  • "SubscriberToken": "subscriber_abc123def456",
  • "PhoneNumber.E164": "+1234567890",
  • "VenueID": "venue_67890",
  • "KeyID": "keypool_12345",
  • "Calling-Station-Id": "aa:bb:cc:dd:ee:ff"
}

Response samples

Content type
application/json
{
  • "UsageData": [
    ]
}

/venuemgmtconsole/subscribers/listPayments

Query payment intent records with multi-field filtering (email, phone, tokens, external IDs, Stripe customer ID). Supports date range filtering, venue/unit/plan filtering, and automatic payload reduction for large datasets (>5000 records). Returns complete transaction history with Stripe integration, receipt URLs, pricing details, and refund tracking.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
EmailAddress
string <email>

Filter payments for specific subscriber email address

SubscriberToken
string

Filter payments for specific subscriber token

PhoneNumber.E164
string

Filter payments for specific subscriber phone number in E.164 format

externalSubscriberID
string

Filter payments for external subscriber identifier

externalSubscriptionID
string

Filter payments for external subscription identifier

StripeCustomerID
string

Filter payments for specific Stripe customer

VenueID
string

Filter payments for specific venue

externalVenueID
string

Filter payments for external venue identifier

UnitID_internal
string

Filter payments for specific internal venue unit identifier

externalVenueUnitID
string

Filter payments for external venue unit identifier

ServicePlanID
string

Filter payments for specific service plan

externalServicePlanID
string

Filter payments for external service plan identifier

MaxInvoiceDateTimeUTC.ISO8601
string <date-time>

Filter payments with invoice dates before or equal to this timestamp

MinInvoiceDateTimeUTC.ISO8601
string <date-time>

Filter payments with invoice dates after or equal to this timestamp

MaxStartDateTimeUTC.ISO8601
string <date-time>

Filter payments with subscription start dates before or equal to this timestamp

MinStartDateTimeUTC.ISO8601
string <date-time>

Filter payments with subscription start dates after or equal to this timestamp

Responses

Request samples

Content type
application/json
{
  • "EmailAddress": "john.doe@example.com",
  • "SubscriberToken": "subscriber_abc123def456",
  • "PhoneNumber.E164": "+1234567890",
  • "externalSubscriberID": "ext_sub_789",
  • "externalSubscriptionID": "ext_subscription_456",
  • "StripeCustomerID": "cus_stripe123456",
  • "VenueID": "venue_67890",
  • "externalVenueID": "ext_venue_123",
  • "UnitID_internal": "unit_12345",
  • "externalVenueUnitID": "ext_unit_456",
  • "ServicePlanID": "serviceplan_xyz789",
  • "externalServicePlanID": "ext_plan_abc123",
  • "MaxInvoiceDateTimeUTC.ISO8601": "2024-12-31T23:59:59.999Z",
  • "MinInvoiceDateTimeUTC.ISO8601": "2024-01-01T00:00:00.000Z",
  • "MaxStartDateTimeUTC.ISO8601": "2024-12-31T23:59:59.999Z",
  • "MinStartDateTimeUTC.ISO8601": "2024-01-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "PaymentCount": 3,
  • "NonZeroPaymentCount": 2,
  • "Payments": [
    ]
}

/venuemgmtconsole/subscribers/refundPayment

Process partial or full refunds through Stripe payment processing. Validates payment intent ownership, calculates available refund amount (considering previous refunds), and processes refund with audit logging. Supports multiple currencies and refund reasons (customer request, duplicate, fraud).

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
StripeClientSecret
required
string

Stripe client secret for the payment intent to be refunded

RefundAmount
required
integer >= 1

Refund amount in cents (smallest currency unit)

Currency
required
string
Enum: "USD" "GBP" "CNY" "CAD" "INR" "AUD"

Currency code for the refund amount

VenueID
string

Venue identifier for payment intent validation

Reason
string
Enum: "requested_by_customer" "duplicate" "fraudulent"

Reason for the refund for audit and compliance purposes

Responses

Request samples

Content type
application/json
{
  • "StripeClientSecret": "pi_1234567890abcdef_secret_xyz123",
  • "RefundAmount": 2999,
  • "Currency": "USD",
  • "VenueID": "venue_67890",
  • "Reason": "requested_by_customer"
}

Response samples

Content type
application/json
{
  • "message": "Initiated refund re_1ABC2DEF3GHI for USD 29.99",
  • "refund_id": "re_1ABC2DEF3GHI",
  • "amount_refunded": 2999,
  • "available_balance": 2999,
  • "previous_refunds": 0
}

/venuemgmtconsole/subscribers/listSubscriberLog

Get comprehensive audit logs for subscribers including administrative actions, subscription events, payment activities, and system interactions. Includes administrator information from Cognito, source IP/location/browser tracking, and chronological event sorting with deduplication. Supports venue-specific filtering.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token for venue console access

SubscriberToken
required
string

Unique subscriber identifier for log retrieval

VenueID
string

Optional venue identifier for venue-specific log filtering

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_1234567890abcdef",
  • "VenueID": "venue_67890"
}

Response samples

Content type
application/json
{
  • "log": [
    ]
}

/venuemgmtconsole/subscribers/sendMessage

Send messages to individual subscribers, specific units, buildings, or venue-wide. Validates subscriber via Cognito, tracks message delivery, and maintains audit trails.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token for venue console access

VenueID
required
string

Venue identifier where subscribers are located

Subject
required
string

Message subject line for subscriber communication

Message
required
string

Message content to be sent to subscribers

EmailAddress
string <email>

Optional specific subscriber email address for targeted messaging

UnitID_internal
string

Optional specific unit identifier for unit-based messaging

UnitBuilding
string

Optional building identifier for building-wide messaging

sendEmailNotification
boolean
Default: false

Whether to send email notifications in addition to in-app messages

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "Subject": "Important Venue Update",
  • "Message": "Your service plan has been updated. Please check your account for details.",
  • "EmailAddress": "subscriber@example.com",
  • "UnitID_internal": "unit_456",
  • "UnitBuilding": "Building-A",
  • "sendEmailNotification": true
}

Response samples

Content type
application/json
{
  • "message": "Message sent.",
  • "GivenName": "John",
  • "EmailAddress": "john.doe@example.com",
  • "locale": "en-US"
}

/venuemgmtconsole/subscribers/resetSubscriptionEndConfirmations

Remove previously confirmed subscription end dates to enable service continuation or reactivation. Processes all venue unit policies and maintains audit trails.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token for venue console access

VenueID
required
string

Venue identifier where subscription confirmations should be reset

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890"
}

Response samples

Content type
application/json
{
  • "message": "",
  • "resetDate.ISO8601": "2025-09-11T20:15:30.123Z"
}

/venuemgmtconsole/subscribers/resetSubscriptionStartDate

Change subscription start date for billing cycle adjustments. Validates against existing subscriptions to prevent conflicts, updates Stripe payment intents, and triggers notification emails. Cannot modify after subscription has begun.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token for venue console access

VenueID
required
string

Venue identifier where the subscription is located

UnitID_internal
required
string

Internal venue unit identifier for the subscription

NewStartDateTimeUTC.ISO8601
required
string <date-time>

New subscription start date and time in ISO 8601 UTC format

StartDateTimeUTC.ISO8601
string <date-time>

Optional current start date for validation (prevents setting same date)

Reason
string

Optional reason for the start date modification for audit purposes

doNotResetDatetoMidnight
boolean
Default: false

Skip automatic start-of-day adjustments for residential units

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "UnitID_internal": "unit_456",
  • "NewStartDateTimeUTC.ISO8601": "2025-10-01T10:00:00.000Z",
  • "StartDateTimeUTC.ISO8601": "2025-09-15T10:00:00.000Z",
  • "Reason": "Customer requested delayed activation",
  • "doNotResetDatetoMidnight": false
}

Response samples

Content type
application/json
{
  • "UnitID_internal": "unit_456",
  • "SubscriberToken": "sub_1234567890abcdef",
  • "NewStartDateTimeUTC.ISO8601": "2025-10-01T10:00:00.000Z"
}

/venuemgmtconsole/subscribers/getRefundAmount

Calculate prorated refund amount for subscription cancellations based on unused time and billing policies. Supports immediate or scheduled termination, with timezone-aware end date adjustments for residential units.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token for venue console access

VenueID
required
string

Venue identifier for subscription access validation

StripeClientSecret
required
string

Stripe client secret for the payment intent requiring refund calculation

EndDateTimeUTC.ISO8601
required
string <date-time>

Requested subscription end date for refund calculation

endImmediately
boolean
Default: false

Whether to end subscription immediately without end-of-day adjustments

doNotResetDatetoMidnight
boolean
Default: false

Skip automatic end-of-day adjustments for residential units

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "StripeClientSecret": "pi_1234567890abcdef_secret_xyz123",
  • "EndDateTimeUTC.ISO8601": "2025-10-15T23:59:59.999Z",
  • "endImmediately": false,
  • "doNotResetDatetoMidnight": false
}

Response samples

Content type
application/json
{
  • "UnusedRefundAmount": 1500,
  • "MaxRefundAmount": [
    ],
  • "EndDateTimeUTC.ISO8601": "2025-10-15T23:59:59.999Z"
}

/venuemgmtconsole/subscribers/modifyVenueUnit

Transfer subscriber to a different unit within the same venue. Validates unit availability, prevents scheduling conflicts, preserves billing cycle, and maintains service continuity.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token

VenueID
required
string

Venue identifier containing both units

UnitID_internal
required
string

Current unit identifier for the subscriber

NewUnitID_internal
required
string

Destination unit identifier for subscriber transfer

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "UnitID_internal": "unit_456",
  • "NewUnitID_internal": "unit_789"
}

Response samples

Content type
application/json
{
  • "message": "Unit assignment updated successfully"
}

/venuemgmtconsole/subscribers/resetSubscriptionEndDate

Set, remove, or modify the subscription end date for active subscriptions. Automatically calculates and processes prorated refunds when terminating early.

Operations:

  • Set new end date (timezone-aware)
  • Immediate termination (endImmediately flag)
  • Remove end date (empty string for open-ended subscription)
  • Automatic prorated refund calculation via Stripe
  • Optional manual refund override (requestedRefundAmount)

Note: Updates network policies, triggers webhooks, and sends notification emails. Residential units get automatic end-of-day adjustments unless doNotResetDatetoMidnight is true.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token from Cognito

VenueID
required
string

Venue identifier for the subscription

externalVenueID
string

External venue identifier for property management integration

UnitID_internal
required
string

Internal venue unit identifier for the subscription

externalVenueUnitID
string

External unit identifier for property management system integration

UnitID
string

Legacy unit identifier for compatibility

UnitBuilding
string

Building identifier within venue

UnitFloor
string

Floor identifier within building

NewEndDateTimeUTC.ISO8601
required
string

New subscription end date in ISO 8601 UTC format, or empty string to remove end date

StripeClientSecret
string

Stripe client secret for subscription identification

SetupIntentId
string

Setup intent ID for legacy subscription identification

endImmediately
boolean

Flag to terminate subscription immediately regardless of specified date

requestedRefundAmount
integer

Override refund amount in cents (optional manual refund specification)

CancellationReasons
Array of strings

Array of cancellation reason codes or descriptions

Reason
string

Administrative reason for end date modification

doNotResetDatetoMidnight
boolean

Prevent automatic end-of-day adjustment for timezone processing

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "USA.CA.90210.BEVERLYHILLS.VENUE",
  • "UnitID_internal": "USA.CA.90210.BEVERLYHILLS.VENUE.APT101",
  • "NewEndDateTimeUTC.ISO8601": "2025-12-31T23:59:59.999Z",
  • "Reason": "Contract extension approved"
}

Response samples

Content type
application/json
Example
{
  • "message": "Subscription end date updated to 2025-12-31T23:59:59.999Z",
  • "EndDateTimeUTC.ISO8601": "2025-12-31T23:59:59.999Z",
  • "errorProcessing": false
}

/venuemgmtconsole/subscribers/modifyServicePlan

Upgrade or downgrade service plan with automatic billing adjustments. Validates plan availability at venue and calculates prorated charges for mid-cycle changes via Stripe.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token

VenueID
required
string

Venue identifier for service plan validation

SubscriberToken
required
string

Subscriber identifier for plan modification

NewServicePlanID
required
string

New service plan identifier to assign

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "SubscriberToken": "sub_1234567890abcdef",
  • "NewServicePlanID": "plan_premium_unlimited"
}

Response samples

Content type
application/json
{
  • "message": "Service plan updated successfully"
}

/venuemgmtconsole/subscribers/modifySubscriptionPrice

Apply pricing adjustments, discounts, or promotional rates to subscriber accounts. Updates Stripe payment records and maintains pricing history for audit purposes.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token

VenueID
required
string

Venue identifier for pricing validation

SubscriberToken
required
string

Subscriber identifier for price modification

NewPrice
required
integer

New subscription price in cents

Reason
string

Reason for price modification

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "SubscriberToken": "sub_1234567890abcdef",
  • "NewPrice": 2999,
  • "Reason": "Promotional discount applied"
}

Response samples

Content type
application/json
{
  • "message": "Subscription price updated successfully"
}

/venuemgmtconsole/subscribers/applyOneTimeCredit

Apply one-time billing credits for service adjustments, compensation, or promotions. Updates Stripe payment processing and maintains credit history for compliance tracking.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token

VenueID
required
string

Venue identifier for credit validation

SubscriberToken
required
string

Subscriber identifier for credit application

CreditAmount
required
integer

Credit amount to apply in cents

Reason
string

Reason for credit application

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "SubscriberToken": "sub_1234567890abcdef",
  • "CreditAmount": 1500,
  • "Reason": "Service interruption compensation"
}

Response samples

Content type
application/json
{
  • "message": "One-time credit applied successfully"
}

/networkoperatorconsole/subscribers/addKey

Create subscriber accounts with WiFi key generation or update existing subscriber access.

Required Parameters:

  • AccessToken - Network operator authentication token for administrative access

Account Resolution Parameters (at least one required):

  • EmailAddress - Subscriber email address for account identification and communication
  • PhoneNumber - Subscriber phone number in E.164 format for SMS notifications
  • SubscriberToken - Existing subscriber token for account updates

Optional Parameters:

  • VenueID - Target venue identifier for subscriber assignment
  • ServicePlanID - Service plan identifier (defaults to venue default)
  • externalServicePlanID - External service plan ID for property management integration

Features:

  • Automatic account resolution by email/phone/token
  • Service plan assignment and venue unit linking
  • Stripe billing setup integration
  • Secure WPA2/WPA3 password generation
  • Bulk provisioning support
  • Cross-venue management capabilities
  • Property management system integration
Authorizations:
CognitoAuth
Request Body schema: application/json
required
One of
AccessToken
required
string

Network operator authentication token for administrative access

EmailAddress
required
string <email>

Subscriber email address for account identification and communication

PhoneNumber
string

Subscriber phone number in E.164 format for SMS notifications

SubscriberToken
string

Existing subscriber token for account updates

VenueID
required
string

Target venue identifier for subscriber assignment

ServicePlanID
string

Service plan identifier (optional - defaults to venue default)

externalServicePlanID
string

External service plan ID for property management integration

UserPartForNewKey
string [ 1 .. 40 ] characters

User-specified portion of WiFi password (1-40 characters)

NewKey
string [ 8 .. 63 ] characters

Complete WiFi password for legacy system imports (8-63 characters)

GivenName
string

Subscriber first name

FamilyName
string

Subscriber last name

object

Nested policy configuration for venue unit assignment and addressing

Responses

Request samples

Content type
application/json
Example

Create new subscriber account with WiFi key using email identification

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "EmailAddress": "tenant@grandhotel.com",
  • "VenueID": "venue_grand_hotel_downtown",
  • "GivenName": "Sarah",
  • "FamilyName": "Johnson",
  • "UserPartForNewKey": "SarahWiFi2024",
  • "ServicePlanID": "plan_premium_unlimited",
  • "PolicyforSubscriberKey": {
    }
}

Response samples

Content type
application/json
Example

New subscriber account created with WiFi access and billing setup

{
  • "message": "WiFi key created successfully",
  • "errorProcessing": false,
  • "SubscriberToken": "sub_new_subscriber_123",
  • "EmailAddress": "tenant@grandhotel.com",
  • "GivenName": "Sarah",
  • "FamilyName": "Johnson",
  • "PhoneNumber.E164": "+15559876543",
  • "StripeCustomerID": "cus_stripe_customer_abc123",
  • "StripeSetupIntentId": "seti_setup_intent_def456",
  • "StripeClientSecret": "seti_secret_client_xyz789",
  • "StripePublishableKey": "pk_live_stripe_key_789",
  • "Subscription": {
    },
  • "dateAddedUTC.ISO8601": "2025-09-12T10:30:00.000Z"
}

/networkoperatorconsole/admin/deleteSubscriberTransactionsPermanently

⚠️ CRITICAL WARNING: This operation permanently removes all financial transaction data and network policies for a subscriber. Deletion cannot be undone and complies with PCI-DSS secure data destruction requirements.

Required Parameters:

  • AccessToken - Network operator authentication with administrative privileges
  • SubscriberToken - Unique subscriber identifier (system-generated token)

Deletion Process (5 Sequential Steps):

  1. Close Subscriber Account - Calls CloseSubscriberAccount to terminate active subscriptions, cancel Stripe subscriptions, and update account status
  2. Payment Intent Deletion - Removes all payment intent records in batches of 100 (prevents memory overflow for subscribers with thousands of transactions)
  3. Network Policies Cleanup - Deletes unit_policy_for_psk edges for all PSKs associated with subscriber across all venue units
  4. Cache Invalidation - Clears policy references and subscriber data
  5. Audit Trail Creation - Creates immutable log entry with administrator details, IP address, timestamp, and "Deleted transactions permanently" event

Data Permanently Removed:

  • Payment Intents - All payment intent records matching SubscriberToken + OperatorID
  • Transaction History - Payment records, billing events, Stripe payment intents, refund records, credit applications
  • Network Policies - Network access policies connecting subscriber to venue units
  • Active Subscriptions - Subscription closures via CloseSubscriberAccount (Stripe cancellations, subscription status updates)
  • Policy References - Network access policies and subscriber associations

Batch Processing Logic:

  • Queries payment intent count for subscriber
  • Processes deletions in batches of 100 records to prevent memory issues
  • Continues while loop until all payment intents are deleted
  • Each batch synchronized across all regions before removal
  • Console logs transaction count after each batch

Multi-Region Synchronization:

  • Synchronized deletion across primary and backup regions
  • Validates successful replication before removal
  • Ensures data consistency across all storage systems

Access Control Cleanup:

  • Removes network access policies for subscriber PSKs
  • Clears subscriber bandwidth tracking data
  • Removes device associations

Error Handling:

  • Payment intent deletion wrapped in try-catch: "Failed to delete subscription from server(s)" on error
  • Policy deletion wrapped in try-catch: "Failed to delete policies from server(s)" on error
  • Sets errorProcessing flag and statusCode on any failure
  • While loop exits immediately if errorProcessing flag is set (prevents partial deletions)
  • Console.error logs exception details for debugging

PCI-DSS Compliance:

  • Secure Data Destruction - Complete removal of payment intent records from all database nodes
  • Cross-Region Validation - Ensures no financial data remnants in backup systems
  • Audit Trail Preservation - Creates log entry with deletion event, administrator identity, timestamp for regulatory compliance
  • Access Control - Requires network operator authentication and SubscriberToken validation

Returns:

  • Success Response - responseBody with "Transactions removed." message plus account closure confirmation from CloseSubscriberAccount
  • Error Response - Specific error messages: "Subscriber not found", "Failed to delete subscription from server(s)", "Failed to delete policies from server(s)"
  • Audit Log Reference - Log vertex with function_name, OperatorID, SubscriberToken, event details for compliance tracking

Integration with CloseSubscriberAccount:

  • First step calls CloseSubscriberAccount to handle active subscription terminations
  • Handles active subscription terminations, Stripe subscription cancellations, and account status updates
  • Returns updated status and response with subscription closure details
  • Ensures subscriber has no active billing before deleting transaction history
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative deletion privileges

SubscriberToken
required
string

Unique subscriber identifier (system-generated token) for transaction deletion

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_1234567890abcdef"
}

Response samples

Content type
application/json
{
  • "message": "Subscription closed. Transactions removed. ",
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/admin/deleteSubscriberAccountPermanently

⚠️ CRITICAL WARNING: This operation permanently and irrevocably deletes all subscriber data. Once completed, the deletion cannot be undone. This action complies with data privacy regulations including GDPR Article 17 (Right to Erasure) and CCPA Section 1798.105.

Required Parameters:

  • AccessToken - Network operator authentication with administrative privileges
  • SubscriberToken - Unique subscriber identifier

What Gets Deleted:

  • Personal Information - Name, email address, phone number, login credentials, profile preferences
  • Service History - Active subscriptions, service agreements, usage history, network sessions, support interactions
  • Financial Records - Payment methods, billing history, transactions, invoices, credits, and refunds
  • Network Access - Device registrations (MAC addresses), WiFi credentials, network policies, and access permissions
  • Activity Logs - Authentication events, session history, and system usage records

Deletion Process:

  1. Terminates all active subscriptions and cancels recurring billing
  2. Removes all financial transaction records and payment history
  3. Deletes subscriber activity logs and session history
  4. Removes network access policies and device registrations
  5. Deletes authentication credentials and WiFi access keys
  6. Removes subscriber account and personal information
  7. Clears all system references to the subscriber
  8. Creates immutable audit log entry documenting the deletion

Data Privacy Compliance:

  • GDPR Compliant - Fulfills Article 17 Right to Erasure requirements
  • CCPA Compliant - Satisfies Section 1798.105 deletion obligations
  • Complete Removal - All subscriber data permanently deleted from production and backup systems
  • Audit Trail - Deletion event logged with administrator details and timestamp for regulatory compliance
  • Irreversible - No recovery possible after deletion completes

Important Notes:

  • Active subscriptions will be canceled immediately
  • Any scheduled payments will be stopped
  • WiFi and network access will be terminated instantly
  • Deletion typically completes within 60 seconds
  • An audit record of the deletion is retained for compliance purposes
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative deletion privileges

SubscriberToken
required
string

Unique subscriber identifier (system-generated token) for complete account deletion

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_1234567890abcdef"
}

Response samples

Content type
application/json
{
  • "message": "Subscription closed. Transactions removed. Subscriber account deleted. ",
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/subscribers/listSubscribers

Retrieve comprehensive subscriber portfolio with analytics and account management data.

Required Parameters:

  • AccessToken - Subscriber portfolio access privileges

Features:

  • Portfolio Management - Account profiles, contact details, service plans
  • Revenue Analysis - Revenue per subscriber, lifetime value
  • Usage Analysis - Bandwidth consumption, usage patterns, forecasting
  • Retention Analytics - Churn prediction, retention insights
  • Compliance Reporting - Regulatory compliance data

Returns: Account profiles, service plans, usage analytics, bandwidth consumption, billing status, payment history, support interactions, satisfaction metrics, venue assignments, device registrations with analytics including revenue, lifetime value, usage forecasting, capacity planning, service optimization recommendations.

Filtering: By venue, service plan, account status, usage patterns (high/medium/low), billing status, payment health, date ranges for historical analytics.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

VenueID
required
string

Target venue identifier for subscriber filtering (use 'ALL' for network-wide view)

ServicePlanFilter
Array of strings

Filter subscribers by specific service plans

AccountStatusFilter
Array of strings
Items Enum: "ACTIVE" "SUSPENDED" "TERMINATED" "TRIAL" "PENDING"

Filter by account status

UsageThreshold
string
Default: "ALL"
Enum: "HIGH" "MEDIUM" "LOW" "ALL"

Filter subscribers by usage patterns

BillingStatusFilter
Array of strings
Items Enum: "CURRENT" "PAST_DUE" "CREDIT_HOLD" "PREPAID" "COMP"

Filter by billing status

object
AnalyticsLevel
string
Default: "standard"
Enum: "basic" "standard" "comprehensive"

Level of analytics data to include

object
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "ALL",
  • "ServicePlanFilter": [
    ],
  • "AccountStatusFilter": [
    ],
  • "UsageThreshold": "HIGH",
  • "AnalyticsLevel": "comprehensive",
  • "Pagination": {
    },
  • "IncludeAnalytics": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "portfolioSummary": {
    },
  • "servicePlanDistribution": [
    ],
  • "subscribers": [
    ],
  • "pagination": {
    },
  • "analytics": {
    }
}

/networkoperatorconsole/subscribers/enableSubscriberConsole

Enable subscriber access to self-service customer portal with customizable features and security settings.

Portal Features:

  • Account profile and contact management
  • Real-time usage analytics and historical reports
  • Billing history/payments/invoices
  • Support ticket creation and knowledge base
  • Device management and connection monitoring
  • Notification preferences

Required Parameters:

  • AccessToken - Administrative authentication
  • SubscriberID - Target subscriber identifier
  • ConsoleAccessLevel - BASIC/STANDARD/ADVANCED/PREMIUM
  • AuthenticationMethod - PASSWORD/SMS_VERIFICATION/EMAIL_VERIFICATION/MULTI_FACTOR
  • InitialCredentials - Username, TemporaryPassword, SecurityQuestions

Optional Parameters:

  • CustomBranding - BrandColor, LogoURL, CompanyName
  • FeaturePermissions - BillingAccess, UsageAnalytics, SupportTickets, ServiceControl, DeviceManagement
  • NotificationPreferences - Welcome email, SMS notifications

Security: MFA setup, secure password policies, account lockout protection, session timeout management, mobile-optimized responsive design.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for console access enablement

ConsoleAccessLevel
required
string
Enum: "BASIC" "STANDARD" "ADVANCED" "PREMIUM"

Level of console access to grant

AuthenticationMethod
required
string
Enum: "PASSWORD" "SMS_VERIFICATION" "EMAIL_VERIFICATION" "MULTI_FACTOR"

Primary authentication method for subscriber console

required
object
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "ConsoleAccessLevel": "STANDARD",
  • "AuthenticationMethod": "MULTI_FACTOR",
  • "InitialCredentials": {
    },
  • "CustomBranding": {},
  • "FeaturePermissions": {
    },
  • "NotificationPreferences": {
    },
  • "SessionSettings": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "consoleActivationId": "CONSOLE_ACT_987654321",
  • "subscriber": {
    },
  • "authentication": {},
  • "permissions": {
    },
  • "branding": {
    },
  • "notifications": {
    },
  • "sessionConfiguration": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/resendCodeforTandC

Send password reset codes or welcome notifications to subscribers for console access recovery.

Required Parameters:

  • AccessToken - Domain administrator or customer support privileges
  • One of: SubscriberToken, EmailAddress, or PhoneNumber (E.164 format)

Optional Parameters:

  • NotificationChannel - EMAIL/SMS for multi-channel delivery

Workflows:

  • CONFIRMED Subscribers - Receive new temporary password (8-character random, single-use, expires after login) stored in PasswordResetCode field with reset notification
  • FORCE_CHANGE_PASSWORD Subscribers - Receive welcome notification with existing temporary password

Features: Email delivery as primary method, SMS support, automatic template selection (reset vs welcome), delivery preferences configuration, operator email/SMS server validation, subscriber verification, complete audit trail with administrator identification.

Security: Cognito authentication ensures only authorized network operators can initiate password resets.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator access token with domain administrator or customer support privileges

SubscriberToken
required
string

Subscriber identifier for password reset code delivery

EmailAddress
string <email>

Subscriber email address for account lookup (alternative to SubscriberToken)

PhoneNumber
string^\+[1-9]\d{1,14}$

E.164 formatted phone number for subscriber identification (alternative to SubscriberToken)

NotificationChannel
string
Enum: "EMAIL" "SMS"

Preferred notification delivery channel

Responses

Request samples

Content type
application/json
Example

Send reset code using subscriber token identification

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "5978d2e8-9540-4612-816f-1d14f6ba38e8",
  • "NotificationChannel": "EMAIL"
}

Response samples

Content type
application/json
Example

Reset code delivered via configured notification channel

{
  • "message": "Password reset notification sent successfully",
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/subscribers/addCallingStationWhitelist

Add devices to subscriber authorized device whitelist for secure network access control.

Supported Devices: Smartphones, tablets, laptops, desktops, IoT devices, smart TVs, gaming consoles, network equipment, business equipment, guest devices.

Required Parameters:

  • AccessToken - Administrative authentication
  • SubscriberID - Target subscriber identifier
  • DeviceMAC - MAC address (validated format)
  • DeviceType - Device category
  • AccessLevel - FULL_ACCESS/LIMITED_ACCESS/GUEST_ACCESS/IOT_ACCESS/BUSINESS_ACCESS

Optional Parameters:

  • DeviceName/DeviceDescription - Device identification
  • AccessDuration - PERMANENT/TEMPORARY/SCHEDULED with ExpirationDate and MaxHours
  • BandwidthLimit - Download/Upload Mbps, PriorityLevel (HIGH/MEDIUM/LOW)
  • ContentFilter - FilterLevel (NONE/BASIC/MODERATE/STRICT/CUSTOM), BlockedCategories (ADULT_CONTENT, SOCIAL_MEDIA, GAMING, STREAMING, P2P, MALWARE)

Features: MAC address validation, duplicate detection, conflict prevention, real-time network configuration updates, complete audit trail.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for device whitelist modification

DeviceMAC
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC address of device to be added to whitelist

DeviceType
required
string
Enum: "SMARTPHONE" "TABLET" "LAPTOP" "DESKTOP" "IOT_DEVICE" "SMART_TV" "GAMING_CONSOLE" "NETWORK_EQUIPMENT" "BUSINESS_EQUIPMENT" "GUEST_DEVICE"

Category of device being authorized

AccessLevel
required
string
Enum: "FULL_ACCESS" "LIMITED_ACCESS" "GUEST_ACCESS" "IOT_ACCESS" "BUSINESS_ACCESS"

Level of network access to grant to the device

DeviceName
string

User-friendly name for device identification

DeviceDescription
string

Detailed description of device for administrative purposes

object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "DeviceMAC": "AA:BB:CC:DD:EE:FF",
  • "DeviceType": "SMARTPHONE",
  • "AccessLevel": "FULL_ACCESS",
  • "DeviceName": "John's iPhone",
  • "DeviceDescription": "iPhone 15 Pro - Personal device for primary account holder",
  • "AccessDuration": {
    },
  • "BandwidthLimit": {
    },
  • "ContentFilter": {
    },
  • "NotificationSettings": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "whitelistEntryId": "WL_ENTRY_987654321",
  • "subscriber": {
    },
  • "device": {
    },
  • "accessConfiguration": {
    },
  • "networkConfiguration": {
    },
  • "notifications": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/removeCallingStationWhitelist

Remove MAC addresses from subscriber calling station whitelists for device de-authorization and network access revocation.

Required Parameters:

  • AccessToken - Administrative authentication
  • SubscriberID - Target subscriber identifier
  • DeviceMAC - MAC address (validated format)
  • RemovalReason - DEVICE_REPLACEMENT, SECURITY_INCIDENT, ACCOUNT_CHANGE, LOST_STOLEN, POLICY_VIOLATION, SUBSCRIBER_REQUEST, MAINTENANCE, COMPLIANCE, DEVICE_MALFUNCTION, TEMPORARY_SUSPENSION

Optional Parameters:

  • ForceRemoval - Override active connections
  • GracePeriod - EnableGracePeriod, GraceDurationMinutes (5-1440), NotificationMessage
  • NotifySubscriber - Send removal notification
  • ArchiveDevice - Preserve device history
  • CleanupSessions - Immediate session cleanup
  • RemovalNotes - Administrative notes

Features: MAC address verification, active connection management with graceful termination, session cleanup, security validation, immediate network access revocation, centralized control, batch operations, temporary suspension with restoration, emergency revocation, compliance enforcement, real-time network configuration updates, complete audit trail.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for device whitelist modification

DeviceMAC
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC address of device to be removed from whitelist

RemovalReason
required
string
Enum: "DEVICE_REPLACEMENT" "SECURITY_INCIDENT" "ACCOUNT_CHANGE" "LOST_STOLEN" "POLICY_VIOLATION" "SUBSCRIBER_REQUEST" "MAINTENANCE" "COMPLIANCE" "DEVICE_MALFUNCTION" "TEMPORARY_SUSPENSION"

Reason for device de-authorization

ForceRemoval
boolean
Default: false

Override active connections and immediately remove device access

object
NotifySubscriber
boolean
Default: true

Whether to notify subscriber of device removal

ArchiveDevice
boolean
Default: true

Whether to maintain device history for potential restoration

CleanupSessions
boolean
Default: true

Whether to cleanup all active device sessions immediately

RemovalNotes
string

Additional notes about device removal for administrative purposes

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "DeviceMAC": "AA:BB:CC:DD:EE:FF",
  • "RemovalReason": "DEVICE_REPLACEMENT",
  • "ForceRemoval": false,
  • "GracePeriod": {
    },
  • "NotifySubscriber": true,
  • "ArchiveDevice": true,
  • "CleanupSessions": true,
  • "RemovalNotes": "Device replaced with newer model - iPhone 15 Pro upgrade"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "removalId": "REMOVAL_987654321",
  • "subscriber": {
    },
  • "device": {
    },
  • "removalProcess": {
    },
  • "networkConfiguration": {
    },
  • "notifications": {
    },
  • "archiveStatus": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/addNASWhitelist

Add Network Access Servers (NAS) to subscriber whitelists for controlled network infrastructure access.

Supported NAS Types: WIRELESS_AP, ETHERNET_SWITCH, VPN_GATEWAY, AUTH_SERVER, EDGE_DEVICE, ROUTER, FIREWALL, LOAD_BALANCER.

Required Parameters:

  • AccessToken - Administrative authentication
  • SubscriberID - Target subscriber identifier
  • NASID - Network Access Server identifier
  • NASType - NAS device category
  • AccessLevel - FULL_INFRASTRUCTURE/LIMITED_ACCESS/MAINTENANCE_ACCESS/GUEST_NETWORK/BUSINESS_ACCESS

Optional Parameters:

  • NASName/NASDescription - Device identification
  • NASLocation - Building, Floor, Room, GPS Coordinates
  • AccessDuration - PERMANENT/TEMPORARY/SCHEDULED/MAINTENANCE with ExpirationDate and MaintenanceWindow
  • BandwidthLimit - MaxThroughputMbps, ConcurrentConnections, PriorityLevel (CRITICAL/HIGH/MEDIUM/LOW)
  • SecurityPolicy - EncryptionRequired, AuthenticationMethod (WPA3_ENTERPRISE/WPA2_ENTERPRISE/RADIUS/CERTIFICATE/MULTI_FACTOR), AccessControlList
  • NotificationSettings - Notification preferences

Features: NAS identity verification, infrastructure security assessment, duplicate detection, security validation, network segmentation, centralized control, capacity limits, temporary access, bulk operations, category management, real-time network configuration updates, complete audit trail.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for NAS whitelist modification

NASID
required
string

Network Access Server identifier to be added to whitelist

NASType
required
string
Enum: "WIRELESS_AP" "ETHERNET_SWITCH" "VPN_GATEWAY" "AUTH_SERVER" "EDGE_DEVICE" "ROUTER" "FIREWALL" "LOAD_BALANCER"

Category of NAS being authorized

AccessLevel
required
string
Enum: "FULL_INFRASTRUCTURE" "LIMITED_ACCESS" "MAINTENANCE_ACCESS" "GUEST_NETWORK" "BUSINESS_ACCESS"

Level of network access to grant through the NAS

NASName
string

User-friendly name for NAS identification

NASDescription
string

Detailed description of NAS for administrative purposes

object
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "NASID": "NAS_AP001_LOBBY",
  • "NASType": "WIRELESS_AP",
  • "AccessLevel": "FULL_INFRASTRUCTURE",
  • "NASName": "Lobby Wireless Access Point",
  • "NASDescription": "Main lobby wireless access point - high-capacity dual-band",
  • "NASLocation": {
    },
  • "AccessDuration": {
    },
  • "BandwidthLimit": {
    },
  • "SecurityPolicy": {
    },
  • "NotificationSettings": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "whitelistEntryId": "NAS_WL_987654321",
  • "subscriber": {
    },
  • "nas": {
    },
  • "networkConfiguration": {
    },
  • "performanceMetrics": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/removeNASWhitelist

Remove Network Access Servers (NAS) from subscriber whitelists for infrastructure de-authorization and access revocation.

Required Parameters:

  • AccessToken - Administrative authentication
  • SubscriberID - Target subscriber identifier
  • NASID - Network Access Server identifier
  • RemovalReason - INFRASTRUCTURE_UPGRADE, SECURITY_INCIDENT, MAINTENANCE, DECOMMISSIONING, POLICY_CHANGE, SUBSCRIBER_REQUEST, END_OF_LIFE, PERFORMANCE_ISSUES, COMPLIANCE, EMERGENCY_SHUTDOWN

Optional Parameters:

  • ForceRemoval - Override active connections
  • GracePeriod - EnableGracePeriod, GraceDurationMinutes (5-1440), NotificationMessage
  • NotifySubscriber - Send removal notification
  • ArchiveNAS - Preserve NAS history
  • CleanupConnections - Immediate connection cleanup
  • MaintenanceWindow - ScheduledMaintenance, MaintenanceStartTime, EstimatedDuration
  • RemovalNotes - Administrative notes

Features: NAS identity verification, active connection management with graceful termination, session cleanup, security validation, immediate infrastructure access revocation, centralized control, batch operations, emergency revocation, maintenance mode, real-time network configuration updates, complete audit trail.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for NAS whitelist modification

NASID
required
string

Network Access Server identifier to be removed from whitelist

RemovalReason
required
string
Enum: "INFRASTRUCTURE_UPGRADE" "SECURITY_INCIDENT" "MAINTENANCE" "DECOMMISSIONING" "POLICY_CHANGE" "SUBSCRIBER_REQUEST" "END_OF_LIFE" "PERFORMANCE_ISSUES" "COMPLIANCE" "EMERGENCY_SHUTDOWN"

Reason for NAS de-authorization

ForceRemoval
boolean
Default: false

Override active connections and immediately remove NAS access

object
NotifySubscriber
boolean
Default: true

Whether to notify subscriber of NAS removal

ArchiveNAS
boolean
Default: true

Whether to maintain NAS history for potential restoration

CleanupConnections
boolean
Default: true

Whether to cleanup all active connections through NAS immediately

object
RemovalNotes
string

Additional notes about NAS removal for administrative purposes

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "NASID": "NAS_AP001_LOBBY",
  • "RemovalReason": "INFRASTRUCTURE_UPGRADE",
  • "ForceRemoval": false,
  • "GracePeriod": {
    },
  • "NotifySubscriber": true,
  • "ArchiveNAS": true,
  • "CleanupConnections": true,
  • "MaintenanceWindow": {
    },
  • "RemovalNotes": "Legacy access point being replaced with Wi-Fi 6E model"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "removalId": "NAS_REMOVAL_987654321",
  • "subscriber": {
    },
  • "nas": {
    },
  • "removalProcess": {
    },
  • "networkConfiguration": {
    },
  • "maintenanceInfo": {
    },
  • "archiveStatus": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/removeKey

Remove specific authentication keys from subscriber accounts for secure key lifecycle management.

Required Parameters:

  • AccessToken - Network operator authentication with subscriber management privileges
  • SubscriberID - Target subscriber identifier
  • KeyID - Specific key identifier to be removed
  • RemovalReason - Reason for key removal (SECURITY_INCIDENT/KEY_COMPROMISE/SERVICE_DEACTIVATION/CREDENTIAL_ROTATION/SUBSCRIBER_REQUEST/COMPLIANCE/KEY_EXPIRY/SYSTEM_MIGRATION/POLICY_VIOLATION/MAINTENANCE)

Optional Parameters:

  • KeyType - Key type filter (API_KEY/ACCESS_TOKEN/SERVICE_KEY/SESSION_KEY/DEVICE_KEY/TEMP_KEY/ADMIN_KEY)
  • ForceRemoval - Override active sessions for immediate removal
  • GracePeriod Options:
    • EnableGracePeriod - Allow delayed removal with notification
    • GraceDurationMinutes - Grace period duration (5-1440 minutes)
    • NotificationMessage - Custom notification message for subscriber
  • NotifySubscriber - Send removal notification to subscriber
  • ArchiveKey - Preserve key metadata in audit history (key value excluded)
  • CleanupSessions - Immediate session cleanup and termination
  • RemovalNotes - Additional notes for audit trail

Features:

  • Key identity verification and validation
  • Active session management with graceful termination
  • Credential cleanup and security validation
  • Immediate authentication revocation
  • Centralized control with batch operations
  • Emergency revocation capabilities
  • Lifecycle management and audit trail
  • Real-time authentication system updates
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for key removal

KeyID
required
string

Specific key identifier to be removed from subscriber account

RemovalReason
required
string
Enum: "SECURITY_INCIDENT" "KEY_COMPROMISE" "SERVICE_DEACTIVATION" "CREDENTIAL_ROTATION" "SUBSCRIBER_REQUEST" "COMPLIANCE" "KEY_EXPIRY" "SYSTEM_MIGRATION" "POLICY_VIOLATION" "MAINTENANCE"

Reason for key removal

KeyType
string
Enum: "API_KEY" "ACCESS_TOKEN" "SERVICE_KEY" "SESSION_KEY" "DEVICE_KEY" "TEMP_KEY" "ADMIN_KEY"

Type of key being removed

ForceRemoval
boolean
Default: false

Override active sessions and immediately remove key access

object
NotifySubscriber
boolean
Default: true

Whether to notify subscriber of key removal

ArchiveKey
boolean
Default: true

Whether to maintain key history for audit purposes (key value excluded)

CleanupSessions
boolean
Default: true

Whether to cleanup all active sessions using the key immediately

RemovalNotes
string

Additional notes about key removal for administrative purposes

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "KeyID": "KEY_API_123456",
  • "RemovalReason": "CREDENTIAL_ROTATION",
  • "KeyType": "API_KEY",
  • "ForceRemoval": false,
  • "GracePeriod": {
    },
  • "NotifySubscriber": true,
  • "ArchiveKey": true,
  • "CleanupSessions": true,
  • "RemovalNotes": "Regular 90-day credential rotation - replaced with new API key"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "removalId": "KEY_REMOVAL_987654321",
  • "subscriber": {
    },
  • "key": {
    },
  • "removalProcess": {
    },
  • "authenticationSystem": {
    },
  • "sessionCleanup": {
    },
  • "notifications": {
    },
  • "archiveStatus": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/resetKey

Reset and regenerate subscriber authentication keys for secure credential lifecycle management.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

CurrentKeyID
required
string

Current key identifier to be reset

UserPartForNewKey
string <= 40 characters

User-defined part for new key generation (max 40 characters, WPA-valid characters only)

NewKey
string [ 8 .. 63 ] characters

Complete new key value (8-63 characters, WPA-valid characters only)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "CurrentKeyID": "KEY_API_123456",
  • "UserPartForNewKey": "MyNewKey2025"
}

Response samples

Content type
application/json
{
  • "message": "Wi-Fi password updated."
}

/networkoperatorconsole/subscribers/modifySubscriptionPrice

Modify subscriber subscription pricing with flexible pricing management and billing adjustments.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with pricing management privileges

SubscriberID
required
string

Target subscriber identifier for pricing modification

required
object
EffectiveDate
required
string <date>

Date when pricing changes should take effect

ModificationReason
required
string
Enum: "PROMOTIONAL_CAMPAIGN" "CUSTOMER_RETENTION" "COMPETITIVE_ADJUSTMENT" "LOYALTY_REWARD" "VOLUME_DISCOUNT" "SERVICE_UPGRADE" "MARKET_POSITIONING" "BILLING_CORRECTION" "POLICY_UPDATE" "SPECIAL_OFFER"

Reason for pricing modification

ProrationMethod
string
Default: "DAILY_PRORATION"
Enum: "IMMEDIATE" "NEXT_CYCLE" "DAILY_PRORATION" "FULL_CYCLE_CREDIT"

Method for handling mid-cycle pricing changes

object
NotifySubscriber
boolean
Default: true

Whether to notify subscriber of pricing changes

ApprovalRequired
boolean
Default: false

Whether pricing change requires additional approval

object
object
ModificationNotes
string

Additional notes about pricing modification

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "PriceModification": {
    },
  • "EffectiveDate": "2025-10-01",
  • "ModificationReason": "PROMOTIONAL_CAMPAIGN",
  • "ProrationMethod": "DAILY_PRORATION",
  • "PromotionalPeriod": {
    },
  • "NotifySubscriber": true,
  • "ApprovalRequired": false,
  • "BillingOptions": {
    },
  • "ModificationNotes": "Q4 promotional campaign - 15% discount for 3 months"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "modificationId": "PRICE_MOD_987654321",
  • "subscriber": {
    },
  • "pricingChanges": {
    },
  • "promotionalInfo": {
    },
  • "billingImpact": {
    },
  • "financialAnalysis": {
    },
  • "notifications": {
    },
  • "approvalStatus": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/applyOneTimeCredit

Apply one-time billing credits to subscriber accounts for flexible billing adjustments and promotional credit management.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
One of
AccessToken
required
string

Network operator authentication token with billing management privileges

SetupIntentId
required
string

Stripe setup intent identifier for the subscriber

StripeClientSecret
string

Stripe client secret for the subscriber payment setup

NewBillingCyclePriceAdjustment
required
integer [ -999999 .. 999999 ]

Credit amount in cents (use negative value for credit, positive for charge)

VenueID
string

Venue identifier for venue-specific operations

Reason
string <= 500 characters

Business reason for applying the credit

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "StripeClientSecret": "pi_1ABC123DEF456GHI789_secret_XYZ",
  • "NewBillingCyclePriceAdjustment": -2500,
  • "Reason": "Service outage compensation - 2 hour downtime on 2025-09-10"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "creditApplied": {
    },
  • "billingImpact": {
    },
  • "subscriber": {
    },
  • "auditTrail": {
    }
}

/networkoperatorconsole/subscribers/modifyVenueUnit

Migrate subscriber subscriptions between venue units enabling seamless subscriber relocations within venues.

Required Parameters:

  • AccessToken - Network operator authentication with subscriber management privileges
  • NewUnitID_internal - Target venue unit internal identifier for migration destination (min 5 characters)
  • SetupIntentId OR StripeClientSecret - Subscriber payment identification (one required)

Optional Parameters:

  • VenueID - Venue identifier for venue console access validation
  • Reason - Business reason for unit migration (max 500 characters)

Migration Process:

  • Automatic policy migration and network configuration changes
  • Service continuity during transitions with VLAN assignment updates
  • Unit availability validation and address updates
  • Service activation in new location with venue scope validation
  • Unit capacity management and overlapping subscription handling
  • Gateway configuration and PSK migration

Features:

  • Access control transfer with authentication continuity
  • Network isolation configuration and security policy transfer
  • Active subscription validation and payment status confirmation
  • Service eligibility verification with real-time unit availability checks
  • Policy compatibility assessment
  • Supports permanent/temporary/emergency/scheduled/bulk migrations
  • Real-time processing with complete audit trail
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
One of
AccessToken
required
string

Network operator authentication token with subscriber management privileges

NewUnitID_internal
required
string >= 5 characters

Target venue unit internal identifier for migration destination

SetupIntentId
required
string

Stripe setup intent identifier for the subscriber

StripeClientSecret
string

Stripe client secret for the subscriber payment setup

VenueID
string

Venue identifier for venue console access validation

Reason
string <= 500 characters

Business reason for unit migration

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SetupIntentId": "seti_1ABC123DEF456GHI789",
  • "NewUnitID_internal": "unit_12345_internal_abc",
  • "Reason": "Subscriber relocation to unit 205 due to apartment change"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "migration": {
    },
  • "subscriber": {
    },
  • "networkConfiguration": {
    },
  • "auditTrail": {
    },
  • "message": "Migrating key for sub_ABC123DEF456, ssid: VaultWiFi_104 from unit_104_internal to unit_205_internal"
}

/networkoperatorconsole/subscribers/resetSubscriptionStartDate

Reset and modify subscription start dates for flexible service activation scheduling and billing adjustments.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscription management privileges

UnitID_internal
required
string

Internal venue unit identifier for subscription location

NewStartDateTimeUTC.ISO8601
required
string <date-time>

New subscription start date and time in ISO 8601 UTC format

StartDateTimeUTC.ISO8601
string <date-time>

Current start date for validation and comparison

Reason
string <= 500 characters

Business reason for start date change

doNotResetDatetoMidnight
boolean

Skip automatic start-of-day adjustments for residential units

VenueID
string

Venue identifier for venue-specific operations

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "UnitID_internal": "unit_12345_internal_abc",
  • "NewStartDateTimeUTC.ISO8601": "2025-10-15T00:00:00.000Z",
  • "Reason": "Delayed move-in - tenant requested service activation postponed to October 15"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "subscription": {
    },
  • "scheduling": {
    },
  • "billingImpact": {
    },
  • "networkConfiguration": {
    },
  • "notifications": {
    },
  • "auditTrail": {
    }
}

/networkoperatorconsole/subscribers/getRefundAmount

Calculate accurate pro-rated refund amounts for subscription cancellations and service terminations.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with financial management privileges

StripeClientSecret
required
string

Stripe client secret for subscription payment identification

EndDateTimeUTC.ISO8601
required
string <date-time>

Proposed subscription end date for refund calculation in ISO 8601 UTC format

endImmediately
boolean

Whether to end subscription immediately without end-of-day adjustments

doNotResetDatetoMidnight
boolean

Skip automatic time adjustments for residential units

requestedRefundAmount
integer [ 0 .. 999999 ]

Specific refund amount requested in cents (overrides calculated amount)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "StripeClientSecret": "pi_1ABC123DEF456GHI789_secret_XYZ",
  • "EndDateTimeUTC.ISO8601": "2025-10-20T23:59:59.999Z",
  • "endImmediately": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "refundAnalysis": {
    },
  • "billingDetails": {
    },
  • "paymentHistory": {
    },
  • "subscriptionDetails": {
    },
  • "calculation": {
    }
}

/networkoperatorconsole/subscribers/resetSubscriptionEndDate

Reset subscription end dates, manage cancellations, and process automatic refunds with intelligent refund calculations.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator authentication token with subscription management privileges

NewEndDateTimeUTC.ISO8601
required
string

New subscription end date in ISO 8601 UTC format (empty string to remove end date)

StripeClientSecret
required
string

Stripe client secret for subscription identification

SetupIntentId
string

Setup intent identifier for subscription lookup

UnitID_internal
string

Internal venue unit identifier

SubscriberToken
string

Subscriber authentication token

endImmediately
boolean

End subscription immediately without end-of-day adjustments

doNotResetDatetoMidnight
boolean

Skip automatic time adjustments for residential units

requestedRefundAmount
integer [ 0 .. 999999 ]

Specific refund amount in cents (overrides calculated amount)

CancellationReasons
Array of strings

Array of cancellation reasons for audit purposes

VenueID
string

Venue identifier for venue-specific operations

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "StripeClientSecret": "pi_1ABC123DEF456GHI789_secret_XYZ",
  • "NewEndDateTimeUTC.ISO8601": "2025-10-31T23:59:59.999Z",
  • "CancellationReasons": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "subscription": {
    },
  • "refundProcessing": {
    },
  • "cancellationDetails": {
    },
  • "networkConfiguration": {
    },
  • "auditTrail": {
    }
}

/networkoperatorconsole/subscribers/closeSubscriberAccount

Permanently close subscriber accounts, terminate all active subscriptions, and revoke administrative privileges.

Required Parameters:

  • AccessToken - Network operator authentication with subscriber management privileges
  • Account Identification - One of: SubscriberToken, EmailAddress, or UnitID_internal

Optional Parameters:

  • Reason - Business reason for account closure (max 40 characters) for audit trail
  • VenueID - Venue identifier for venue-specific operations

Account Closure Process:

  • Immediate active subscription cancellation and network access revocation
  • Comprehensive service cleanup with cache invalidation
  • Automatic refund processing for pro-rated unused services
  • Subscription billing schedule cancellation with automatic refund calculation
  • Secure payment method cleanup and financial reporting integration

Administrative Privilege Revocation:

  • Venue administrator privileges across all venues
  • Leasing agent access removal
  • Network operator domain administrator privileges
  • SIEM administrator access removal
  • Customer support access revocation

Data & Compliance:

  • Permanent account marking as closed with timestamp
  • Proper data retention handling per privacy regulations
  • Secure cleanup of sensitive data and authentication credentials
  • Complete access log generation and audit trail
  • Privacy regulation compliance (GDPR, CCPA, etc.)

Features:

  • Real-time processing with instant service termination
  • Complete audit compliance and comprehensive reporting
  • Administrative privilege audit and verification
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberToken
required
string

Subscriber authentication token for account identification

EmailAddress
string <email>

Subscriber email address for account lookup

UnitID_internal
string

Internal venue unit identifier for subscriber location

Reason
string <= 40 characters

Business reason for account closure (max 40 characters)

VenueID
string

Venue identifier for venue-specific operations

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_ABC123DEF456",
  • "Reason": "Customer request - account termination"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "accountClosure": {
    },
  • "subscriptionTermination": {
    },
  • "accessRevocation": {
    },
  • "dataCleanup": {
    },
  • "auditTrail": {
    },
  • "message": "Account Closed - sub_ABC123DEF456. Reason: Customer request - account termination"
}

/networkoperatorconsole/subscribers/refundPayment

Process partial and full refunds on subscriber payments through Stripe payment integration.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with payment management privileges

StripeClientSecret
required
string

Stripe client secret identifying the payment intent to refund

RefundAmount
required
integer [ 1 .. 1000000 ]

Refund amount in smallest currency unit (cents, pence, etc.)

Currency
required
string
Enum: "USD" "GBP" "CNY" "CAD" "INR" "AUD"

Currency code for refund processing

Reason
string
Enum: "requested_by_customer" "duplicate" "fraudulent"

Reason for refund (optional) - used for Stripe refund categorization

VenueID
string

Venue identifier for venue-specific refund processing (optional)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "StripeClientSecret": "pi_1ABC123DEF456GHI789_secret_XYZ",
  • "RefundAmount": 1550,
  • "Currency": "USD",
  • "Reason": "requested_by_customer",
  • "VenueID": "venue_ABC123"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "refundDetails": {
    },
  • "originalPayment": {
    },
  • "auditTrail": {
    },
  • "message": "Initiated refund re_1ABC123DEF456GHI789 for $15.50"
}

/networkoperatorconsole/subscribers/forgetSubscriberDevices

Clear subscriber device cache from Redis storage to resolve connectivity issues and support network troubleshooting.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
SubscriberToken
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_-]{1,255}$

Unique subscriber identifier for device cache clearing. This token is used to locate and delete all cached device information associated with the subscriber.

Responses

Request samples

Content type
application/json
Example

Clear all cached device information for a specific subscriber to resolve connectivity issues

{
  • "SubscriberToken": "sub_abc123def456"
}

Response samples

Content type
application/json

Device cache successfully cleared for subscriber

{
  • "message": "Subscriber device cache cleared successfully"
}

/networkoperatorconsole/subscribers/listSubscriberKeys

Retrieve comprehensive WiFi authentication key information for subscribers including WPA2 PSK credentials, keypool associations, venue unit policies, and device connection details.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberToken
required
string

Subscriber authentication token for direct account identification

EmailAddress
string <email>

Subscriber email address for account lookup

PhoneNumber
string

Subscriber phone number in E.164 format for account identification

externalSubscriberID
string

External system subscriber identifier for property management integration

VenueID
string

Venue identifier for venue-specific key filtering (optional)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_ABC123DEF456"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "subscriberInfo": {
    },
  • "keyInventory": {
    },
  • "keysInKeyPools": {
    },
  • "allDevices": {
    }
}

/networkoperatorconsole/subscribers/listSubscriberLog

Retrieve comprehensive activity logs and audit trails for subscriber accounts including administrative actions, subscription events, payment activities, and system interactions.

Required Parameters:

  • AccessToken - Network operator authentication with subscriber management privileges
  • Account Identification - One of: SubscriberToken, EmailAddress, PhoneNumber (E.164 format), or externalSubscriberID

Optional Parameters:

  • VenueID - Venue identifier for venue-specific log filtering

Audit Trail Features:

  • Administrator identification (full name and email from Cognito)
  • Source tracking (IP addresses, geographic location, browser information)
  • UTC timestamps with millisecond accuracy
  • Function tracing for technical troubleshooting
  • Structured event data with action-specific parameters

Event Categories:

  • Account Management: Administrative actions, service changes, authentication events
  • Support Activities: Configuration changes, billing activities, service provisioning
  • Payment Events: Successful payments, failed payments, refunds, chargebacks, renewal processing
  • Network Events: WiFi key generation, device associations, connection activities
  • Integration Events: External system interactions, API calls, data synchronization
  • System Events: Cognito authentication logs, error events, migration events

Data Processing:

  • Multi-source integration from system logs and subscription events
  • Automatic operator filtering and event deduplication
  • JSON event processing with error handling
  • Event enrichment with context information
  • Data validation and format standardization
  • Chronological organization (most recent first)
  • Filtering capabilities and pagination support
  • Performance optimization for large datasets

Features:

  • Real-time processing with complete audit compliance
  • Comprehensive event tracking across all subscriber activities
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberToken
required
string

Subscriber authentication token for direct account identification

EmailAddress
string <email>

Subscriber email address for account lookup

PhoneNumber
string

Subscriber phone number in E.164 format for account identification

externalSubscriberID
string

External system subscriber identifier for property management integration

VenueID
string

Venue identifier for venue-specific log filtering (optional)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_ABC123DEF456",
  • "VenueID": "venue_ABC123"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "subscriberInfo": {
    },
  • "logSummary": {
    },
  • "log": [
    ]
}

/networkoperatorconsole/subscribers/listSubscriberKeySessions

Retrieve active and historical session information for subscriber WiFi keys with connection analytics and device tracking.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberToken
required
string

Subscriber authentication token for direct account identification

EmailAddress
string <email>

Subscriber email address for account lookup

PhoneNumber.E164
string

Subscriber phone number in E.164 format for account identification

KeyID
string

WiFi key identifier for key-specific session filtering (optional)

VenueID
string

Venue identifier for venue-specific session filtering (optional)

Calling-Station-Id
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

Device MAC address for device-specific filtering (optional, format: 00:11:22:33:44:55)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_ABC123DEF456",
  • "VenueID": "venue_ABC123"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "analyticsOverview": {
    },
  • "usageData": [
    ],
  • "deviceBreakdown": [
    ]
}

/networkoperatorconsole/subscribers/listPayments

Retrieve comprehensive payment history and billing analytics for subscribers with advanced financial transaction management.

Required Parameters:

  • AccessToken - Network operator authentication with subscriber management and financial data access privileges
  • Account Identification - One of: SubscriberToken, EmailAddress, PhoneNumber.E164, VenueID, UnitID_internal, or ServicePlanID

Optional Parameters:

  • External System Correlation: externalSubscriberID, externalSubscriptionID, externalVenueID, externalVenueUnitID, externalServicePlanID
  • Date Range Filtering: Invoice dates and payment success timestamps (automatic 2-year lookback for historical analysis)

Stripe Integration:

  • Payment intent tracking and receipt URL generation
  • Charge ID correlation and customer profile management
  • Real-time Stripe synchronization
  • PCI-compliant payment data handling

Billing Analytics:

  • Service Plan Pricing: Venue/unit-level pricing adjustments, billing frequency analysis
  • Revenue Aggregation: Multi-currency processing (USD/GBP)
  • Bandwidth Pricing: Download/upload speed with price-per-Gbps calculations
  • Billing Cycle Analysis: Billing cycle hours, bandwidth allocation, pricing adjustments

Returns:

  • Payment counts (total and non-zero) with revenue totals
  • Detailed payment records with Stripe payment intent IDs, client secrets, receipt URLs
  • Refund information and complete venue details (address, external IDs)
  • Subscriber information and service plan details

Security & Compliance:

  • Cognito authentication with operator isolation
  • Role-based financial data access
  • Complete audit trail compliance

Performance:

  • Optimized for high-performance financial queries
  • Indexed database operations
  • Efficient revenue aggregation
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
Any of
AccessToken
required
string

Network operator authentication token with subscriber management and financial data access privileges

SubscriberToken
required
string

Subscriber authentication token for direct account payment history retrieval

EmailAddress
string <email>

Subscriber email address for payment history lookup

PhoneNumber.E164
string

Subscriber phone number in E.164 format for payment identification

VenueID
string

Venue identifier for venue-specific payment history filtering

UnitID_internal
string

Internal venue unit identifier for unit-specific billing history

ServicePlanID
string

Service plan identifier for plan-specific revenue analysis

externalSubscriberID
string

External system subscriber identifier for cross-platform correlation

externalSubscriptionID
string

External billing system subscription identifier

externalVenueID
string

External property management system venue identifier

externalVenueUnitID
string

External system venue unit identifier

externalServicePlanID
string

External billing system service plan identifier

StripeCustomerID
string

Stripe customer identifier for payment platform correlation

MinInvoiceDateTimeUTC.ISO8601
string <date-time>

Minimum invoice date for date range filtering (ISO8601 format)

MaxInvoiceDateTimeUTC.ISO8601
string <date-time>

Maximum invoice date for date range filtering (ISO8601 format)

MinStartDateTimeUTC.ISO8601
string <date-time>

Minimum service start date for subscription lifecycle filtering

MaxStartDateTimeUTC.ISO8601
string <date-time>

Maximum service start date for subscription lifecycle filtering

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "sub_ABC123DEF456",
  • "VenueID": "venue_ABC123",
  • "MinInvoiceDateTimeUTC.ISO8601": "2025-01-01T00:00:00Z",
  • "MaxInvoiceDateTimeUTC.ISO8601": "2025-12-31T23:59:59Z"
}

Response samples

Content type
application/json
{
  • "PaymentCount": 47,
  • "NonZeroPaymentCount": 42,
  • "BillingCycleHours": 8760,
  • "DownloadKbps": 5000000,
  • "UploadKbps": 1000000,
  • "PricePerDownloadGbps.USD": 25.99,
  • "VenuePriceAdjustment": -150,
  • "VenueUnitPriceAdjustment": -75.5,
  • "ListBillingCyclePrice.USD": 2549.99,
  • "NetBillingCyclePrice.USD": 2324.49,
  • "MinInvoiceDateTimeUTC.ISO8601": "2025-01-15T10:30:00Z",
  • "MaxInvoiceDateTimeUTC.ISO8601": "2025-09-12T19:30:00Z",
  • "Payments": [
    ]
}

/venuemgmtconsole/subscribers/updateSubscriberPII

Update subscriber personal information and contact preferences for venue-managed accounts with secure PII handling.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
One of
AccessToken
required
string

Cognito authentication token for venue administrator with network operator permissions

EmailAddress
required
string <email>

Subscriber email address for identification (one identification method required)

PhoneNumber
string

Subscriber phone number for identification (one identification method required)

SubscriberToken
string

Internal subscriber token for direct identification (one identification method required)

GivenName
string <= 40 characters

Updated first name (HTML sanitized, trimmed to 40 characters)

FamilyName
string <= 40 characters

Updated last name (HTML sanitized, trimmed to 40 characters)

PhoneNumber.E164
string

Updated phone number in E.164 international format

contactpref_sms
boolean

SMS contact preference (automatically retrieved from existing subscriber data)

contactpref_email
boolean

Email contact preference (automatically retrieved from existing subscriber data)

locale
string
Enum: "en-us" "es-xl"

Language preference for communications

Status
string

Account status (administrative access required)

externalSubscriberID
string <= 40 characters

External system subscriber identifier (HTML sanitized, trimmed to 40 characters)

Responses

Request samples

Content type
application/json
Example

Venue administrator updating guest's personal information

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "EmailAddress": "guest@grandhotel.com",
  • "GivenName": "John",
  • "FamilyName": "Smith",
  • "PhoneNumber.E164": "+15559876543"
}

Response samples

Content type
application/json

Subscriber profile updated through venue management console

{
  • "message": "",
  • "errorProcessing": false,
  • "data": {
    }
}

Keypools

🔑 Key Pool Management

Management of authentication key pools for subscriber access control and venue-specific authentication services.

Key Pool Operations

  • 🔑 Pool Creation: Create and configure new authentication key pools
  • 📊 Pool Management: Monitor key usage, availability, and performance metrics
  • 🔄 Key Rotation: Automated and manual key rotation policies and procedures
  • 📋 Assignment Rules: Venue-specific key pool assignment and distribution
  • 🛡️ Security Policies: Key expiration, access control, and security configurations
  • 📈 Analytics: Usage tracking, performance monitoring, and capacity planning

Integration Features

  • 🏢 Venue Binding: Associate key pools with specific venues and operators
  • ⚙️ Policy Engine: Advanced rules for key distribution and management
  • 📊 Reporting: Comprehensive key usage and security analytics
  • 🔧 Maintenance: Pool cleanup, optimization, and health monitoring

/venuemgmtconsole/venue_units/listKeyPoolsatVenueUnit

Retrieves WiFi key pools and pre-shared key (PSK) configurations available for a specific venue unit, providing SSID information for WPA2 authentication access control.

Requires AccessToken for venue administration authentication, VenueID for venue identifier, and UnitID_internal for target unit. Returns WPA2 PSK key pools with SSID details, including venue-wide pools (no unit assignment) and unit-specific pools (explicitly assigned). Excludes global pools to focus on venue-specific configurations.

Access is controlled through Cognito authentication with venue administrator permissions ensuring users only access key pool information for venues they are authorized to manage.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Cognito access token for authentication. Must belong to a user with venue administration privileges for the specified venue.

VenueID
required
string

Unique identifier of the venue for which to list key pools. Must be a venue the authenticated user has administrative access to.

UnitID_internal
required
string

Internal identifier of the specific venue unit. Used to filter key pools that are either globally available to the venue or specifically assigned to this unit.

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "UnitID_internal": "unit_67890"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "Keypools": {
    }
}

/networkoperatorconsole/keypools/listKeypools

Retrieve complete keypool (WiFi network) catalog with authentication mechanisms, venue connections, scope information, and usage statistics.

Required Parameters:

  • AccessToken - Network operator authentication
  • VenueID - Venue identifier

Returns:

  • myKeyPoolCount - Total number of WiFi networks configured
  • myKeyPoolList - Detailed information for each WiFi network

WiFi Network Information:

  • KeyPoolID - Unique network identifier
  • SSID - WiFi network name
  • Scope - 'global' (available at all venues) or 'local' (specific venues only)
  • AuthenticationMechanism - 'WPA2' or 'WPA3' security protocol
  • DisplayOrder - Presentation priority for user interfaces (1-100)
  • RuckusR1ControllerID - Controller ID for WPA3 authentication (when applicable)
  • RuckusR1DPSKPoolName - DPSK pool display name from Ruckus R1 controller (for WPA3 only)
  • PSKCount - Number of access credentials in network
  • SubscriberCount - Number of active users
  • ConnectedVenueList - Venues where network is available (empty for global networks)

Security Protocols:

  • WPA2 - Standard WiFi security with pre-shared keys
  • WPA3 - Enhanced security with dynamic keys via Ruckus R1 Controller

Scope Options:

  • Global - Network available at all venues (ConnectedVenueList will be empty)
  • Local - Network available at specific venues only (ConnectedVenueList shows locations)
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token (domain administrator, account manager, or customer support)

VenueID
required
string

Venue identifier (required for API consistency but not used in query logic)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "OP123.USA.CA.94102.APARTMENTS.123"
}

Response samples

Content type
application/json
Example
{
  • "myKeyPoolCount": 3,
  • "myKeyPoolList": {
    },
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/keypools/addKeypool

Create new keypool (SSID) for network operator with automatic venue attachments based on scope. Supports WPA2-PSK and WPA3-DPSK authentication via Ruckus R1 Controller integration. Multi-region synchronized deployment.

Required Parameters:

  • AccessToken - JWT authentication token (domain administrator or NetworkSoftwareProvider access required)
  • SSID - SSID name (2-32 characters, WiFi standards compliant, auto-trimmed to 32)
  • OperatorID - Required for NetworkSoftwareProvider role; auto-populated for DomainAdministrator from context

Optional Parameters:

  • VenueID - Venue ID for local scope attachment (automatically sets Scope to 'local')
  • Scope - Explicit scope: 'global' (default) or 'local' (generates random 8-char identifier)
  • RuckusR1ControllerID - Ruckus R1 Controller ID for WPA3-DPSK (requires explicit Scope, sets AuthenticationMechanism to 'WPA3')
  • RuckusR1DPSKPoolName - DPSK pool display name from Ruckus R1 controller (optional, for display purposes)

Authentication Mechanisms:

  • WPA2 PSK - Pre-shared key authentication (default)
  • WPA3 DPSK - Dynamic pre-shared key via Ruckus R1 Controller (when RuckusR1ControllerID provided, optionally with RuckusR1DPSKPoolName)
  • PEAP MSCHAPv2 - 802.1x enterprise authentication via RADIUS (when AuthenticationMechanism='PEAP MSCHAPv2')

Scope Types & Venue Attachment:

  • Global scope - Automatically attached to ALL operator venues
  • Local scope with VenueID - Attached to specified venue only
  • Local scope without VenueID - No automatic venue attachment (manual configuration via configureKeyPool required)

KeyPoolID Format:

  • Structure: {OperatorID}._V3SSID.{SSID}.{scope}
  • Example (global): OP123._V3SSID.GuestWiFi.global
  • Example (local): OP123._V3SSID.ResidentWiFi.a8f3d2e1

Validation Checks:

  • Code branch write access permission
  • OperatorID presence and validity
  • SSID length (2-32 chars) and WiFi standards compliance (regex validation)
  • VenueID existence in operator's venues (if provided)
  • SSID uniqueness at venue or venue units (if VenueID provided)
  • Random scope generation uniqueness (max 10 attempts for local scope)
  • KeyPoolID uniqueness (prevents duplicate creation)
  • Keypool count limit (500 per operator)
  • Ruckus R1 Controller resource path validation (/config/addRuckusR1Controller or /config/configureRuckusR1Controller)

Keypool Creation:

  • Creates keypool profile with KeyPoolID as unique identifier
  • Associates PSK storage container for key management
  • Links keypool to network operator account
  • Establishes venue associations based on scope (global or local)
  • Writes audit log entry with event 'Keypool added'
  • Synchronizes configuration across all regions
  • Automatically applies initial configuration settings

Returns:

  • KeyPoolID - Generated keypool identifier
  • SSID - SSID name (returned on success)
  • message - Success message with venue attachments and configureKeyPool result

Processing Flow:

  1. Validates authentication and role permissions (NetworkSoftwareProvider or DomainAdministrator)
  2. Validates SSID format and length
  3. Determines scope (VenueID sets local, RuckusR1ControllerID requires explicit Scope)
  4. Generates random scope identifier for local scope without venue
  5. Creates KeyPoolID and validates uniqueness
  6. Creates keypool profile and storage container
  7. Attaches to venues based on scope
  8. Synchronizes to all regions
  9. Applies initial configuration
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token from Cognito or legacy auth

OperatorID
string

Network operator ID (required for NetworkSoftwareProvider, auto-populated for DomainAdministrator)

SSID
required
string [ 2 .. 32 ] characters

SSID name (2-32 characters, WiFi standards compliant, automatically trimmed to 32)

VenueID
string

Venue ID for local scope attachment (automatically sets scope to 'local')

Scope
string
Enum: "global" "local"

Keypool scope: 'global' (default, all venues) or 'local' (specific venues/units)

RuckusR1ControllerID
string

Ruckus R1 Controller ID for WPA3-DPSK authentication (requires explicit Scope parameter)

RuckusR1DPSKPoolName
string

Ruckus R1 DPSK pool display name (optional, for display purposes only)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SSID": "GuestWiFi",
  • "Scope": "global"
}

Response samples

Content type
application/json
Example
{
  • "KeyPoolID": "OP123._V3SSID.GuestWiFi.global",
  • "SSID": "GuestWiFi",
  • "message": "Keypool added: OP123._V3SSID.GuestWiFi.global. Attached keypool to 25 venues. ",
  • "errorProcessing": false
}

/networkoperatorconsole/keypools/configureKeypool

Configure existing keypool (SSID) including venue connections/disconnections, display order management, and permanent deletion. Supports dynamic venue attachment/detachment for local scope keypools with multi-region synchronization.

Required Parameters:

  • AccessToken - JWT authentication token (domain administrator access required)
  • KeyPoolID - Keypool identifier to configure (format: {OperatorID}._V3SSID.{SSID}.{scope})

Configuration Operations (6 types):

  • Connect Venue - connectVenueID parameter links keypool to venue (local scope only)
  • Disconnect Venue - disconnectVenueID parameter removes venue connection (local scope only)
  • Update Display Order - DisplayOrder parameter (1-100) sets UI presentation priority
  • Permanent Deletion - deleteKeyPoolPermanently=true removes keypool and all associated data (local scope only)
  • Special Admin Route - /admin/deleteKeypoolPermanently path automatically sets deleteKeyPoolPermanently=true
  • Multi-Region Coordination - Synchronized execution across all regions

Scope Restrictions:

  • Global scope - Cannot connect/disconnect venues (already connected to all), cannot delete
  • Local scope - Supports all operations including venue management and deletion

Venue Connection Behavior:

  • connectVenueID parameter - Links keypool to specified venue
  • disconnectVenueID parameter - Removes venue connection
  • Automatic validation: venue must belong to same operator
  • Transactional updates ensure consistency

Permanent Deletion Process:

  • Validates local scope (global pools protected)
  • Removes all associated WiFi keys and PSK data
  • Deletes keypool storage container
  • Removes all venue associations
  • Deletes keypool profile
  • Irreversible operation - requires explicit confirmation

Processing Flow:

  1. Validates authentication and domain administrator role
  2. Coordinates multi-region execution
  3. Validates KeyPoolID exists and belongs to operator
  4. Determines operation type from parameters (connectVenueID, disconnectVenueID, DisplayOrder, deletion)
  5. Validates scope restrictions (global vs local operations)
  6. Executes configuration updates
  7. Logs configuration changes with audit trail
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token (domain administrator privileges required)

KeyPoolID
required
string

Keypool identifier (format: {OperatorID}._V3SSID.{SSID}.{scope})

connectVenueID
string

Venue ID to connect keypool to (local scope only)

disconnectVenueID
string

Venue ID to disconnect keypool from (local scope only)

DisplayOrder
integer [ 1 .. 100 ]

Display priority order for keypool presentation in UI (1-100, lower numbers appear first)

deleteKeyPoolPermanently
boolean

Set true to permanently delete keypool with all associated data (local scope only, irreversible)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "KeyPoolID": "OP123._V3SSID.ResidentWiFi.a8f3d2e1",
  • "connectVenueID": "OP123.USA.CA.94102.APARTMENTS.123"
}

Response samples

Content type
application/json
Example
{
  • "message": "Connected keypool OP123._V3SSID.ResidentWiFi.a8f3d2e1 to venue OP123.USA.CA.94102.APARTMENTS.123",
  • "errorProcessing": false,
  • "KeyPoolID": "OP123._V3SSID.ResidentWiFi.a8f3d2e1",
  • "statusCode": 200
}

/networkoperatorconsole/admin/deleteKeypoolPermanently

Permanently delete key pool with all associated PSKs and bins.

⚠️ WARNING: Deletion is irreversible - removes all Pre-Shared Keys, bins, and cached references.

Required Parameters:

  • AccessToken - Network operator authentication (domain administrator privileges required)

Safety Restrictions:

  • Cannot delete global scope key pools
  • Validates venue/unit associations before deletion
  • Requires domain administrator privileges

Features:

  • Automatic cleanup across distributed system nodes
  • Complete audit trail
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Domain administrator access token with deletion privileges

KeyPoolID
required
string

Unique key pool identifier for permanent deletion

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "KeyPoolID": "USA.TX.75001.CORPORATE._V3SSID.OLDWIFI.local"
}

Response samples

Content type
application/json
{
  • "message": "Deleted keypool USA.TX.75001.CORPORATE._V3SSID.OLDWIFI.local. All PSKs and bins removed.",
  • "errorProcessing": false,
  • "KeyPoolID": "USA.TX.75001.CORPORATE._V3SSID.OLDWIFI.local"
}

/networkoperatorconsole/scratchcards/extendScratchCardBatch

Extends the validity period for existing scratch card batches to prevent expiration and maintain service availability.

Use Cases:

  • Seasonal distributions with delayed deployment
  • Promotional campaigns requiring extended validity
  • Delayed card deployment scenarios

Features:

  • Add additional hours to scratch card expiration dates
  • Extension applies to all non-invalidated cards in the batch
  • Only affects cards with future expiration dates
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrative access token with NetworkOperator domain administrator privileges required for scratch card batch management operations

KeyPoolID
required
string

Unique identifier of the key pool containing the scratch cards to be extended. Used to locate and validate the specific card batch within the operator's inventory.

ScratchCard_BatchID
required
string <date-time>

ISO 8601 date-time identifier of the scratch card batch to extend. This timestamp represents when the batch was originally created and serves as the unique batch identifier.

ExtendByHours
required
integer [ 1 .. 8760 ]

Number of hours to add to the current expiration date of all cards in the batch. The extension is added to each card's existing EndDateTimeUTC.ISO8601 value.

Responses

Request samples

Content type
application/json
Example

Add 168 hours (7 days) to the scratch card batch expiration

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "KeyPoolID": "keypool_12345678-90ab-cdef-1234-567890abcdef",
  • "ScratchCard_BatchID": "2025-09-01T10:30:25.123Z",
  • "ExtendByHours": 168
}

Response samples

Content type
application/json
Example

Scratch card batch validity extended by 168 hours (7 days)

{
  • "message": "",
  • "2025-09-01T10:30:25.123Z": {
    }
}

/networkoperatorconsole/scratchcards/invalidateScratchCardBatch

Permanently invalidates scratch card batches to prevent unauthorized usage and maintain security.

Features:

  • Immediate deactivation of all cards within specified batch
  • Marks cards with invalidation timestamp
  • Prevents future authentication attempts

Use Cases:

  • Security incident response
  • Compromised batch management
  • Policy enforcement
  • Quality control scenarios requiring permanent card disablement
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrative access token with NetworkOperator domain administrator privileges required for scratch card batch invalidation operations

KeyPoolID
required
string

Unique identifier of the key pool containing the scratch cards to be invalidated. Used to locate and validate the specific card batch within the operator's inventory.

ScratchCard_BatchID
required
string <date-time>

ISO 8601 date-time identifier of the scratch card batch to invalidate. This timestamp represents when the batch was originally created and serves as the unique batch identifier for permanent deactivation.

Responses

Request samples

Content type
application/json
Example

Invalidate compromised scratch card batch for security purposes

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "KeyPoolID": "keypool_12345678-90ab-cdef-1234-567890abcdef",
  • "ScratchCard_BatchID": "2025-09-01T10:30:25.123Z"
}

Response samples

Content type
application/json
Example

Complete scratch card batch marked as invalid with timestamp

{
  • "message": "",
  • "2025-09-01T10:30:25.123Z": {
    }
}

Support & Ticketing

🎫 Integrated Support & Customer Service

Comprehensive support ticket system with ConnectWise PSA integration for venue management and subscriber assistance.

Support Workflow

  • 📋 Ticket Management: Create, assign, track, and resolve support requests
  • 🔄 Multi-Channel Integration: Email, SMS, and console-based communication
  • 📊 Performance Analytics: Response times, resolution rates, satisfaction tracking
  • 🎯 Priority Management: Critical, High, Medium, Low priority classification
  • 🏢 Venue-Specific Routing: Automatic assignment based on venue and category

ConnectWise PSA Integration

  • 🔗 Real-time Sync: Direct integration with ConnectWise Professional Services Automation
  • 🏢 Company Mapping: VAULT property ID to ConnectWise company ID resolution
  • 📋 Advanced Filtering: Multi-property queries with date ranges and status filters
  • 👤 Contact Management: Automatic contact resolution and communication tracking
  • 📈 Reporting: Comprehensive support metrics and performance analytics

/venuemgmtconsole/support/getTickets

Get venue support tickets with filtering by status, priority, and date range. Integrates with external ticketing systems for unified ticket management.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token

VenueID
required
string

Venue identifier for ticket filtering

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890"
}

Response samples

Content type
application/json
{
  • "tickets": [
    ]
}

/venuemgmtconsole/support/addTicket

Submit new support request with priority level, contact details, and issue description. Auto-routes to appropriate team and integrates with external ticketing systems.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrator authentication token

VenueID
required
string

Venue identifier for ticket association

Subject
required
string

Ticket subject or title

Description
required
string

Detailed description of the issue

Priority
required
string
Enum: "low" "medium" "high" "critical"

Ticket priority level

Category
string

Ticket category for routing

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "Subject": "WiFi connectivity issue in Building A",
  • "Description": "Multiple subscribers reporting intermittent connectivity in Building A, units 101-105",
  • "Priority": "high",
  • "Category": "technical"
}

Response samples

Content type
application/json
{
  • "ticketId": "TKT-2025-001234",
  • "message": "Support ticket created successfully"
}

/networkoperatorconsole/support/getTickets

Retrieve support tickets from ConnectWise PSA system with multi-venue support and advanced filtering.

Required Parameters:

  • AccessToken - Network operator authentication

Retrieval Options:

  • Individual Ticket: Lookup by TicketID
  • Venue-Based: Retrieve with date range, email address, and status filtering

Features:

  • Automatic venue-to-company mapping
  • 90-day default lookback period
  • 2-second timeout protection
  • Requires venue-level ConnectWise configuration (URL, authorization, client ID, company ID)
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Authentication token for network operator access

TicketID
string

Specific ConnectWise ticket ID for individual ticket retrieval

VAULTID
Array of strings

Array of Vault venue IDs for multi-venue ticket retrieval

StartDateTimeUTC.ISO8601
string <date-time>

Start date for ticket filtering in ISO8601 format (defaults to 90 days ago)

EndDateTimeUTC.ISO8601
string <date-time>

End date for ticket filtering in ISO8601 format (defaults to tomorrow)

showClosed
boolean

Include closed and resolved tickets in results (defaults to false)

emailAddress
Array of strings <email> [ items <email > ]

Array of email addresses for customer-specific ticket filtering

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "TicketID": "12345",
  • "VAULTID": [
    ],
  • "StartDateTimeUTC.ISO8601": "2025-06-15T00:00:00.000Z",
  • "EndDateTimeUTC.ISO8601": "2025-09-13T00:00:00.000Z",
  • "showClosed": false,
  • "emailAddress": [
    ]
}

Response samples

Content type
application/json
{
  • "12345": {
    },
  • "12346": {
    }
}

/subscriberconsole/getTickets

Access comprehensive support ticket history with ConnectWise integration.

Required Parameters:

  • AccessToken - Subscriber authentication token
  • VenueID - Venue filter

Optional Parameters:

  • TicketID - Retrieve specific ticket details
  • StartDateTimeUTC.ISO8601 - Search range start (default: 90 days ago)
  • EndDateTimeUTC.ISO8601 - Search range end (default: tomorrow)
  • showClosed - Include closed/resolved tickets (default: false)

Returned Data:

  • TicketCount - Total number of tickets found
  • Tickets - Object keyed by ticket ID with: id, summary/title, status, contact name, dates (created/updated)
  • Venue Details - UnitID_support, siteID, VLAN, Purpose, UnitID, Floor, Building, VAULT_ID
  • Notes - Text content (when querying specific ticket)

Features:

  • Multi-venue support across all subscriber's associated venues
  • Email filtering by subscriber's registered email address
  • Company mapping (VAULT venue IDs to ConnectWise companies)
  • Parent tickets only (excludes child tickets)
  • Email verification restricts viewing to matching subscriber email
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier for filtering tickets

TicketID
string

Optional specific ticket ID to retrieve detailed information

StartDateTimeUTC.ISO8601
string <date-time>

Start date for ticket search range (defaults to 90 days ago)

EndDateTimeUTC.ISO8601
string <date-time>

End date for ticket search range (defaults to tomorrow)

showClosed
boolean
Default: false

Include closed/resolved tickets in results

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "showClosed": false
}

Response samples

Content type
application/json
{
  • "TicketCount": 2,
  • "Tickets": {
    }
}

/subscriberconsole/addTicket

Submit technical issues, service requests, or assistance tickets with ConnectWise integration.

Required Parameters:

  • AccessToken - Subscriber authentication
  • VenueID - Venue context
  • contactName - Contact name (max 40 characters)
  • summary - Brief description (max 100 characters)

Optional Parameters:

  • contactEmailAddress - Contact email (defaults to subscriber email)
  • contactPhoneNumber - Phone for follow-up
  • Description - Detailed explanation
  • unitID/VAULTUnitID/CustomUnit - Unit identification
  • TicketType/TicketSubType - Categorization
  • serviceboardid - ConnectWise board routing

Returns: ConnectWise ticket ID, reference number, status, company/site info, and board assignment.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Subscriber authentication token for API access

VenueID
required
string

Venue identifier where the issue is occurring

contactName
required
string <= 40 characters

Contact person name for the ticket (max 40 characters)

summary
required
string <= 100 characters

Brief summary of the issue or request (max 100 characters)

contactEmailAddress
string <email>

Contact email address (defaults to subscriber email if not provided)

contactPhoneNumber
string

Contact phone number for follow-up

Description
string

Detailed description of the issue or request

unitID
string

Specific unit identifier within the venue

VAULTUnitID
string

VAULT-specific unit identifier

CustomUnit
string

Custom unit description if unit ID not available

TicketType
string

Type of ticket for categorization

TicketSubType
string

Sub-category of the ticket

serviceboardid
integer

ConnectWise service board ID for routing

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "contactName": "John Doe",
  • "summary": "Internet connectivity issues",
  • "contactEmailAddress": "john.doe@example.com",
  • "Description": "WiFi connection drops frequently throughout the day",
  • "unitID": "unit_101",
  • "TicketType": "Resident Support",
  • "TicketSubType": "Internet"
}

Response samples

Content type
application/json
{
  • "ticketId": "12345",
  • "ticketNumber": "TKT-2025-001234",
  • "status": "New",
  • "company": {
    },
  • "site": {
    },
  • "board": {
    }
}

Staff

👷 Staff Management & Access Control

Staff member management system for venue administrators, support personnel, and operational staff with role-based access control.

Staff Administration

  • 👤 User Management: Create, modify, and deactivate staff accounts
  • 🔒 Role Assignment: Granular permissions and access control management
  • 🏢 Venue Assignment: Multi-venue staff access and responsibility management
  • 📋 Activity Tracking: Staff actions, login history, and audit trails
  • 🎯 Performance Monitoring: Staff productivity and service quality metrics
  • 📚 Training Management: Certification tracking and training requirements

Access Control

  • 🔐 Permission Matrix: Fine-grained access control for different staff roles
  • 📊 Security Monitoring: Access pattern analysis and security event tracking
  • 🔄 Session Management: Staff session control and security policies
  • 📋 Compliance Tracking: Staff certification and regulatory compliance

/venuemgmtconsole/staff/enableStaffAccess

Grants venue access permissions to staff members for property management and subscriber administration, establishing role-based access controls within the VAULT system.

Key Features:

  • Role Assignment: Grants VenueAdministrator or LeasingAgent permissions for specified venues
  • Account Creation: Creates subscriber account for new staff members with administrative privileges
  • Venue Association: Associates staff member with venue details and access permissions
  • Notification Integration: Sends notification emails with venue details and access information
  • Audit Logging: Maintains comprehensive audit logs of all administrative actions

Role Types:

  • VenueAdministrator: Full venue management access including subscriber administration, configuration, and reporting
  • LeasingAgent: Property management focused access for tenant management and basic administrative functions

Process Flow:

  1. Input Validation: Validates VenueID and Role parameters (VenueAdministrator/LeasingAgent)
  2. Venue Details: Retrieves venue information including name, address, and support contact details
  3. Account Processing: Creates or updates staff subscriber account with administrative role assignment
  4. Permission Grant: Establishes venue-specific access permissions through addSubscription process
  5. Notification: Sends confirmation email with venue details and access instructions
  6. Audit Trail: Creates comprehensive audit log entry with administrator and venue details

Access Control:

  • Function Whitelist: Only allows calls from authorized venue management and network operator functions
  • Venue Validation: Ensures venue exists and is operated by the authenticated network operator
  • Role Validation: Validates role assignment against supported administrative roles
  • Operator Scope: Restricts access to venues within the operator's management scope

Integration Features:

  • Subscription System: Leverages existing subscription management for staff access provisioning
  • Notification Engine: Automatically sends staff onboarding communications
  • Cognito Integration: Establishes authentication and authorization through Cognito user pools
  • Audit System: Records all administrative actions with source tracking and timestamps

Access is controlled through Cognito authentication with network operator or venue administrator permissions ensuring only authorized users can grant staff access to venue management functions.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Cognito access token for authentication. Must belong to a user with venue administration privileges for the specified venue.

VenueID
required
string

Unique identifier of the venue for which staff access is being granted. Must be a venue the authenticated user has administrative access to.

Role
required
string
Enum: "VenueAdministrator" "LeasingAgent"

Administrative role to grant to the staff member. Determines the level of access and permissions within the venue management system.

EmailAddress
required
string <email>

Email address of the staff member receiving access. Used for account creation, authentication, and notifications.

GivenName
required
string <= 40 characters

First name of the staff member for account creation and personalized communications.

FamilyName
required
string <= 40 characters

Last name of the staff member for account creation and identification purposes.

locale
string

Language and region preference for the staff member's account interface and notifications.

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "Role": "VenueAdministrator",
  • "EmailAddress": "staff@example.com",
  • "GivenName": "John",
  • "FamilyName": "Smith",
  • "locale": "en-US"
}

Response samples

Content type
application/json
{
  • "SubscriberToken": "staff_token_67890",
  • "EmailAddress": "staff@example.com",
  • "GivenName": "John",
  • "FamilyName": "Smith",
  • "locale": "en-US",
  • "dateAddedUTC": "2025-09-11T19:36:58.723Z"
}

/venuemgmtconsole/staff/disableStaffAccess

Revokes venue access permissions from staff members for property management and subscriber administration, removing administrative privileges while maintaining account integrity.

Key Features:

  • Permission Revocation: Removes VenueAdministrator and LeasingAgent permissions for specified venues
  • Self-Protection: Prevents administrators from removing their own access for security
  • Complete Removal: Removes both VenueAdministrator and LeasingAgent group memberships
  • Account Preservation: Maintains staff member account while removing venue-specific permissions
  • Audit Logging: Creates comprehensive audit logs of access revocation actions

Access Removal Process:

  1. Input Validation: Validates VenueID and staff member identification (EmailAddress or SubscriberToken)
  2. Self-Check Protection: Prevents administrators from removing their own access permissions
  3. Staff Resolution: Resolves staff member details from provided email address or subscriber token
  4. Permission Removal: Removes VenueAdministrators and LeasingAgents property values from venue
  5. Venue Update: Updates venue modification timestamp to reflect permission changes
  6. Audit Creation: Generates comprehensive audit log with administrator and action details

Security Features:

  • Self-Removal Prevention: Blocks administrators from disabling their own venue access
  • Venue Validation: Ensures venue exists and is operated by the authenticated network operator
  • Staff Verification: Validates staff member exists and has current venue permissions
  • Operator Scope: Restricts access to venues within the operator's management scope

Permission Types Removed:

  • VenueAdministrators: Full venue management access including subscriber administration and configuration
  • LeasingAgents: Property management focused access for tenant management and administrative functions
  • Complete Revocation: Removes all administrative privileges for the specified venue

Data Processing Flow:

  1. Request Validation: Ensures required parameters (VenueID, staff identification) are provided
  2. Staff Resolution: Uses PIIFunctions to resolve staff member details from email or token
  3. Self-Check Validation: Compares requesting administrator with target staff member
  4. Venue Permission Removal: Removes staff member from VenueAdministrators and LeasingAgents groups
  5. Audit Trail Creation: Records permission revocation with administrator and venue details
  6. Response Assembly: Returns success confirmation or error details

Access is controlled through Cognito authentication with network operator or venue administrator permissions ensuring only authorized users can revoke staff access to venue management functions.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
One of
AccessToken
required
string

Cognito access token for authentication. Must belong to a user with venue administration privileges for the specified venue.

VenueID
required
string

Unique identifier of the venue from which staff access is being revoked. Must be a venue the authenticated user has administrative access to.

EmailAddress
required
string <email>

Email address of the staff member whose access is being revoked. Used to identify the staff member account for permission removal.

SubscriberToken
string

Alternative identifier for the staff member whose access is being revoked. Can be used instead of EmailAddress for staff identification.

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "EmailAddress": "staff@example.com"
}

Response samples

Content type
application/json
{
  • "message": "Operation complete. "
}

/networkoperatorconsole/venues/enableStaffAccess

Grant venue management access by creating subscriber account and assigning role permissions.

Required Parameters:

  • AccessToken - Network operator authentication
  • VenueID - Target venue identifier
  • Role - Staff role assignment

Available Roles:

  • VenueAdministrator - Full venue management access
  • LeasingAgent - Resident operations access

Features:

  • Creates authentication credentials
  • Sends welcome notifications
  • Maintains complete audit trail
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token

VenueID
required
string

Unique identifier of the venue for staff access

Role
required
string

Role to assign to staff member - VenueAdministrator for full management, LeasingAgent for resident operations

EmailAddress
required
string

Email address of the staff member

GivenName
required
string

First name of the staff member

FamilyName
string

Last name of the staff member

locale
string

Preferred language locale

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "VenueID": "string",
  • "Role": "string",
  • "EmailAddress": "string",
  • "GivenName": "string",
  • "FamilyName": "string",
  • "locale": "string"
}

Response samples

Content type
application/json
{
  • "SubscriberToken": "string",
  • "EmailAddress": "string",
  • "GivenName": "string",
  • "FamilyName": "string",
  • "locale": "string"
}

/networkoperatorconsole/venues/disableStaffAccess

Remove staff access permissions for venue with immediate or scheduled revocation.

Required Parameters:

  • AccessToken - Network operator authentication

Supported Roles:

  • VenueAdministrator
  • LeasingAgent
  • CustomerService
  • MaintenanceStaff

Optional Parameters:

  • EffectiveDate - Schedule revocation for future date
  • RevocationReason - Reason code (EmploymentTermination/RoleChange/SecurityIncident/BusinessRestructuring/PolicyViolation)
  • AuditNotes - Additional notes for compliance tracking
  • NotificationPreferences - Control notification delivery

Features:

  • Immediate or scheduled revocation
  • Role-specific removal
  • Complete audit trail maintained
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with staff management privileges

VenueID
required
string

Target venue identifier for staff access revocation

StaffEmailAddress
required
string <email>

Email address of staff member whose access is being revoked

Role
required
string
Enum: "VenueAdministrator" "LeasingAgent" "CustomerService" "MaintenanceStaff"

Specific role being revoked from staff member

RevocationReason
required
string
Enum: "EmploymentTermination" "RoleChange" "SecurityIncident" "BusinessRestructuring" "PolicyViolation"

Business justification for access revocation

EffectiveDate
string <date-time>

Optional scheduled revocation date for planned access changes

object
AuditNotes
string

Additional documentation for compliance and audit purposes

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "VENUE_12345",
  • "StaffEmailAddress": "staff.member@venue.com",
  • "Role": "LeasingAgent",
  • "RevocationReason": "EmploymentTermination",
  • "NotificationPreferences": {
    },
  • "AuditNotes": "Access revoked due to employment termination - HR Case #12345"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "revocationId": "REV_789012345",
  • "staffMember": {
    },
  • "venue": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/staff/disableStaffAccess

Staff access revocation endpoint for network operator domain administrators to remove personnel from administrative roles.

⚠️ WARNING: Irreversible operation requiring administrative action to restore. System-wide impact affecting all network operator systems.

Required Parameters:

  • AccessToken - Cognito domain administrator privileges
  • EmailAddress - Staff email (email format validation with automatic lowercase normalization and whitespace trimming)

Administrative Roles Removed:

  • Domain Administrator - Full network operator privileges
  • SIEM Administrator - Security/event management
  • Account Manager - Customer account/billing management

Processing:

  • Authentication validation of staff management permissions
  • Staff identification by email with account existence validation
  • Self-protection check (prevents administrators removing own access)
  • Role removal execution from all administrative groups
  • System coordination updates across integrated operator systems
  • Audit trail creation with administrator details and timestamps

Returns:

  • EmailAddress and DisabledDateTime timestamp
  • OperatorID (automatically derived from access token)
  • RolesRemoved array listing removed administrative roles
  • Success confirmation with errorProcessing boolean

Features:

  • Cross-system coordinated removal
  • Complete audit trail for compliance and security monitoring
  • Comprehensive input validation and sanitization
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

EmailAddress
required
string <email>

Email address of staff member to disable access for (automatically normalized to lowercase)

OperatorID
string

Network operator identifier (automatically derived from AccessToken if not provided)

Responses

Request samples

Content type
application/json
Example

Standard request to remove staff member administrative access

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "EmailAddress": "john.smith@metrowifi.com"
}

Response samples

Content type
application/json

Complete staff access removal with role details

{
  • "message": "",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "EmailAddress": "john.smith@metrowifi.com",
  • "DisabledDateTime": "2025-09-21T14:45:30.123Z",
  • "OperatorID": "op_network_metro_wifi",
  • "RolesRemoved": [
    ]
}

/networkoperatorconsole/staff/enableStaffAccess

Staff access enablement endpoint for granting administrative permissions with role-based access control.

Required Parameters:

  • AccessToken - Cognito authentication
  • EmailAddress - Staff email (email format validation with lowercase normalization)

Optional Parameters:

  • GivenName/FamilyName - Max 40 characters (required for domain roles)
  • VenueID - For venue-specific roles
  • Domain - For network software provider operations

Network Operator Roles:

  • DomainAdministrator - Full network operator privileges
  • SIEMAdministrator - Security/event management
  • AccountManager - Customer account/billing
  • CustomerSupport - Network-wide access

Venue-Specific Roles:

  • VenueAdministrator - Full venue management (requires VenueID)
  • LeasingAgent - Resident operations (requires VenueID)

Role Hierarchy & Authorization:

  • Network Software Provider - Can assign any role to any domain
  • Network Operator Administrator - Can assign any role within their operator network
  • Account Manager/Customer Support - Can only assign venue roles for venues they manage
  • Venue Administrator - Can assign venue staff roles for their specific venue

Processing:

  • Access token validation through Cognito
  • Role authorization check (confirms requestor can grant specified role)
  • Email validation and normalization
  • Venue verification for venue roles
  • Staff account creation with role assignments
  • Automated welcome communications with system access information

Returns:

  • Staff token and Cognito username
  • Assigned roles array
  • Success message with errorProcessing boolean

Features:

  • Multi-locale support (English US, Spanish Latin America)
  • Comprehensive input sanitization
  • Complete audit logging for compliance and security
  • Flexible role assignment with multiple simultaneous roles
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid JWT access token with staff management permissions

EmailAddress
required
string <email>

Email address of the staff member to enable access for (validated and normalized)

GivenName
string <= 40 characters

Staff member's first name (required for domain roles)

FamilyName
string <= 40 characters

Staff member's last name (required for domain roles)

Role
string
Enum: "DomainAdministrator" "SIEMAdministrator" "AccountManager" "CustomerSupport" "VenueAdministrator" "LeasingAgent"

Role to assign to the staff member

VenueID
string

Venue identifier for venue-specific roles (required for VenueAdministrator and LeasingAgent)

Domain
string

Domain assignment for network software provider operations

Responses

Request samples

Content type
application/json
Example

Granting domain administrator role for full network access

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "EmailAddress": "admin@operator.com",
  • "GivenName": "Jennifer",
  • "FamilyName": "Williams",
  • "Role": "DomainAdministrator",
  • "Domain": "operator.network.com"
}

Response samples

Content type
application/json
{
  • "message": "Staff access has been enabled successfully.",
  • "errorProcessing": false,
  • "statusCode": 200,
  • "data": { },
  • "SupportedLocales": {
    }
}

Operator/Equipment

🔧 Network Equipment & Infrastructure

Network equipment management and monitoring for network operators to oversee infrastructure, performance, and maintenance operations.

Equipment Management

  • 🔧 Device Inventory: Complete equipment registry with specifications and status
  • 📊 Performance Monitoring: Real-time equipment health, utilization, and alerts
  • 🔄 Maintenance Scheduling: Preventive maintenance, updates, and lifecycle management
  • 📈 Capacity Planning: Usage analysis, growth projections, and upgrade planning
  • 🛡️ Security Management: Equipment security, firmware updates, and threat monitoring
  • 📋 Configuration Management: Device configurations, backup, and change tracking
  • ⚙️ System Settings: Display options, UI customization, and operator configurations

Operations & Monitoring

  • 📡 Network Topology: Infrastructure mapping and connectivity visualization
  • 🚨 Alert Management: Equipment failures, performance issues, and notification systems
  • 📊 Analytics Dashboard: Equipment performance metrics and trend analysis
  • 🔧 Remote Management: Remote configuration, troubleshooting, and maintenance
  • 🎨 Display Options: User interface appearance, branding, and visual settings

/venuemgmtconsole/venues/listVenueCPEStatus

Retrieves real-time status information for Customer Premises Equipment (CPE) through integrated ConnectWise configuration management and monitoring systems. This endpoint provides comprehensive equipment health monitoring and operational status across venue network infrastructure.

Equipment Categories Monitored:

  • Network Infrastructure: Firewalls, routers, switches, gateways
  • Wireless Systems: Wireless controllers, access points
  • Broadband Equipment: CMTS, cable modems, OLT, ONT devices
  • Specialized Hardware: SmartBox, StreamBlade, Data Plane, G.hn equipment

Integration Features:

  • ConnectWise Integration: Equipment configuration and site assignment data
  • PRTG Monitoring: Real-time ping status and device health metrics
  • Site Mapping: Unit-to-device associations for detailed reporting
  • Flexible Filtering: Support for unit, site, or VAULT ID specific queries

Response Modes:

  • Summary Mode: Aggregate UP/DOWN counts for quick status overview
  • Detailed Mode: Individual device information with unit assignments and timestamps
  • Filtered Views: Single unit, site, or VAULT ID specific reporting

Access Control: Access is controlled through Cognito authentication with venue-specific permissions. Only venues configured with ConnectWise integration are supported.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token for venue administrator access

VenueID
required
string

Unique identifier for the venue to monitor

UnitID
string

Optional filter to show CPE status for specific ConnectWise unit only

SiteID
string

Optional filter to show CPE status for specific ConnectWise site only

VAULTUnitID
string

Optional filter using VAULT unit identifier from ConnectWise configuration

SummaryOnly
boolean
Default: false

Return only aggregate UP/DOWN counts without individual device details

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "SummaryOnly": true
}

Response samples

Content type
application/json
Example
{
  • "Summary": {
    },
  • "message": ""
}

/venuemgmtconsole/venues/listRSSI

Retrieves Received Signal Strength Indicator (RSSI) data for venue wireless infrastructure, providing comprehensive signal quality distribution metrics for network performance monitoring and optimization.

Key Features:

  • Daily RSSI Analytics: End-of-day signal strength distribution across all venue connections
  • Complete Range Coverage: RSSI values from 1 to 128 with connection counts for each level
  • External Venue Support: Automatic resolution of external venue IDs for integration systems
  • Cached Data Retrieval: High-performance access to pre-aggregated RSSI distributions
  • Fallback Mechanism: Venue hash-based data retrieval for enhanced reliability

Signal Strength Analysis:

  • Connection Distribution: Number of active connections at each signal strength level
  • Coverage Assessment: Complete wireless coverage analysis across venue areas
  • Performance Monitoring: Real-time wireless infrastructure quality metrics
  • Zero-Filled Data: Complete distribution visibility with zero values for missing RSSI levels
  • Timestamp Consistency: End-of-day reporting for consistent daily snapshots

Data Processing Flow:

  1. Venue Resolution: Supports external venue ID mapping for integrated systems
  2. Timestamp Calculation: Generates end-of-day timestamp for current reporting period
  3. Cache Query: Retrieves RSSI data from venue monitoring cache using venue ID
  4. Fallback Retrieval: Falls back to venue hash-based lookup if primary data unavailable
  5. Distribution Processing: Converts cached data to structured RSSI distribution array
  6. Range Completion: Fills missing RSSI values (1-128) with zero connection counts
  7. Sorted Response: Returns ordered distribution array sorted by RSSI value

Use Cases:

  • Network Optimization: Identify coverage gaps and signal strength patterns
  • Performance Monitoring: Track wireless infrastructure quality over time
  • Troubleshooting: Diagnose connectivity issues with signal strength analysis
  • Capacity Planning: Understand connection distribution for infrastructure planning

Access is controlled through Cognito authentication with venue-specific permissions ensuring users only access RSSI data for venues they are authorized to manage.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid Cognito access token for venue management authentication

VenueID
string

Internal venue identifier for RSSI data retrieval

externalVenueID
string

External venue identifier (alternative to VenueID)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlZlbnVlIE1hbmFnZXIiLCJpYXQiOjE1MTYyMzkwMjJ9.signature",
  • "VenueID": "venue_67890"
}

Response samples

Content type
application/json
{
  • "RSSIDistribution": [
    ],
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/equipment/listOperatorDetails

Get comprehensive operator configuration including infrastructure settings, API documentation, service integrations, and role-based administrative data. Returns operator identification, contact information, regional settings, API endpoint URLs, Postman documentation links, and integration settings with automatic Stripe/webhook credential masking. Role-based filtering applies different data visibility for administrators vs non-administrative users.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative privileges for full configuration access

VenueID
required
string

Venue identifier for API context (required for consistency across operator console endpoints)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJuZXRvcGVyYXRvcl8xMjMiLCJhZG1pbl9hY2Nlc3MiOnRydWV9...",
  • "VenueID": "downtown_hotel._V3VENUE.op_roamingiq_network"
}

Response samples

Content type
application/json
Example
{}

/networkoperatorconsole/equipment/listServicePlans

Get complete service plan catalog with bandwidth specs, pricing models, device limits, billing cycles, WirelessOnlyPlan settings (requires WirelessOnlyPlanVLANOffset for venue level configuration), and FCC regulatory compliance info. Returns multi-currency pricing with venue-specific price/trial adjustments, upload/download speeds, concurrent device limits, and external system integration IDs. Optional filtering by externalServicePlanID.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Valid Cognito authentication token for network operator administrator or customer support

externalServicePlanID
string

Optional filter to retrieve specific service plan by external system identifier

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

/networkoperatorconsole/venues/configureVenueUnit

Configure comprehensive venue unit settings including identity, address, network, notifications, billing, and integrations. This endpoint validates authentication and authorization, then proxies requests to the primary region's gremlinconsole for execution.

Configurable Properties:

  • Identity: External unit IDs, display names, building/floor designations
  • Address: Street address with postal code validation, city, state, country (ISO3166A3)
  • Network: Per-unit SSID overrides (validated format), VLAN assignment (1-4094), wired access settings
  • Notifications: Email/SMS suppression controls, subscription lifecycle emails
  • Billing: Shopping cart enablement, price adjustments (-100% to +100%)
  • Integrations: RealPage unit ID mapping, SMS short code assignment
  • Deletion: Permanent unit removal (requires zero active subscriptions)

Access Control:

  • Network Software Provider (NSP): Full access across all managed operators
  • Domain Administrator: Access to units within their operator's venues
  • Subscribers: Denied (operator console only)

Handler Architecture: This endpoint is a thin API layer that:

  1. Validates AccessToken via Cognito JWT verification
  2. Enforces role-based access control (NSP or Domain Admin)
  3. Maps request fields via field mapping layer
  4. Proxies to primary region gremlinconsole: https://{API_SUBDOMAIN}.{REGION_PRIMARY}.{DOMAIN}/{CODE_BRANCH}/gremlinconsole/executeCommand
  5. Executes Venue.configureUnit business logic in primary region
  6. Returns sanitized response with CORS headers

Critical Behaviors:

  • Subscription Updates: Changes to UnitID, externalVenueUnitID, Building, or Floor trigger subscription re-configuration
  • VLAN Changes: Updates all associated PSKs and triggers asynchronous gateway re-configuration
  • SSID Validation: Enforces WiFi naming standards (no special chars, 1-32 length)
  • Duplicate Prevention: Rejects duplicate externalVenueUnitID within same venue
  • Input Sanitization: Removes HTML tags and entities from all string fields
  • Multi-Region Sync: Changes synchronized across disaster recovery regions

Performance:

  • Typical execution: 200-500ms (authentication + primary region proxy)
  • VLAN updates may trigger async gateway config (up to 60 seconds)
  • Unit deletion queries all subscriptions before removal

Security:

  • All requests require valid Cognito JWT AccessToken
  • Role-based authorization with operator isolation
  • Input validation and HTML sanitization on all fields
  • Response sanitization removes sensitive data (passwords, tokens)
  • CODE_BRANCH validation prevents cross-environment modifications
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

UnitID_internal
required
string

Internal venue unit identifier (required for unit lookup)

externalVenueUnitID
string <= 40 characters

External venue unit identifier for third-party system integration

UnitID
string <= 40 characters

Human readable venue unit identifier for display purposes

UnitBuilding
string <= 40 characters

Building identifier or name where the unit is located

UnitFloor
string <= 40 characters

Floor identifier or description for the unit location

AddressLine1
string <= 40 characters

Primary address line (street address)

AddressLine2
string <= 40 characters

Secondary address line (apartment, suite, etc.) - can be cleared with single space

City
string <= 40 characters

City name where the unit is located

State
string

State, province, or region where the unit is located

Country
string <= 40 characters

Country name where the unit is located

PostalCode
string <= 40 characters

Postal code validated against international standards

object

Network settings and SSID configuration for the venue unit

object

Notification and communication preferences for subscribers at this venue unit

RealPageUnitID
integer >= 1

RealPage system unit identifier (must be positive integer for integration)

object

E-commerce and shopping cart configuration for the venue unit

vlan
integer [ 1 .. 4094 ]

VLAN ID assignment for network segmentation (triggers PSK updates and gateway re-configuration)

SMSCode
string <= 20 characters

SMS short code for subscriber communications specific to this unit

deleteEmptyVenueUnit
boolean

Permanently delete unit (requires zero active subscriptions unless forceDelete is true) - admin endpoint only

forceDelete
boolean

Force deletion of unit even with active subscriptions - initiates subscription cleanup and gateway decommission, requires retry after equipment is disabled (few minutes)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "UnitID_internal": "unit_12345",
  • "externalVenueUnitID": "EXT-BLDGA-101",
  • "UnitID": "Building A - Apartment 101",
  • "UnitBuilding": "Building A",
  • "UnitFloor": "1st Floor",
  • "AddressLine1": "123 Innovation Drive",
  • "AddressLine2": "Suite 101",
  • "City": "San Francisco",
  • "State": "California",
  • "Country": "United States",
  • "PostalCode": "94105",
  • "NetworkConfiguration": {
    },
  • "Notifications": {
    },
  • "RealPageUnitID": 12345,
  • "ShoppingCart": {
    },
  • "vlan": 100,
  • "SMSCode": "WIFI101"
}

Response samples

Content type
application/json
Example
{
  • "message": "Updated external venue unit ID = EXT-BLDGA-101. Updated unit ID = Building A - Apartment 101. Updated building = Building A. Updated floor = 1st Floor. Updated address line 1 = 123 Innovation Drive. Updated address line 2 = Suite 101. Updated city = San Francisco. Updated state = California. Updated country = United States. Updated postal code = 94105. Added GUEST_WIFI_101 to VenueUnitSSID. Added PREMIUM_ACCESS_101 to VenueUnitSSID. Updating allowOverlappingSubscriptionWiredUnit to false. Updating sendSubscriptionAddedEmail to true. Updating sendSubscriptionEndEmail to true. Updated RealPageUnitID to 12345. Updating enableShoppingCart to true.",
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/venues/updateVenueUnitAddress

Update venue unit address information with validation and geographic positioning. Uses same configureVenueUnit implementation for address updates including AddressLine1/2, City, State, PostalCode, building, floor, and geographic coordinates. Domain administrator access required.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

UnitID_internal
required
string

Internal unit identifier for address update

object

Comprehensive address information for unit

object

Additional location information

object

Geographic positioning data

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "UnitID_internal": "unit_hotel_room_101",
  • "AddressInformation": {
    },
  • "LocationDetails": {
    },
  • "GeographicInformation": {
    }
}

Response samples

Content type
application/json
Example
{
  • "message": "Unit address updated successfully",
  • "AddressConfiguration": {
    },
  • "GeographicData": {
    }
}

/networkoperatorconsole/venues/configureVenue

Configure all venue settings including identity, address, network configuration, service plans, integrations, notifications, shopping cart, and display options. This endpoint uses a regional proxy pattern where requests are validated locally and forwarded to the primary region for execution.

Architecture Pattern:

  • Regional Proxy - Deployed in all AWS regions (us-east-1, us-west-2, eu-west-1)
  • Local Validation - JWT token validation and input checks performed in user's region
  • Primary Region Execution - Business logic executed in us-east-1 with authoritative Neptune database
  • Cross-Region Forwarding - Authenticated requests forwarded to primary region gremlinconsole endpoint

Access Control - Role Hierarchy:

  • Domain Administrator - Full venue configuration for all venues within their operator
  • Account Manager - Full venue configuration for client account management
  • Customer Support - Full venue configuration for troubleshooting and support
  • Venue Administrator - Configuration for specific authorized venues only

Required Parameters:

  • AccessToken - JWT token with appropriate role (Domain Administrator, Account Manager, Customer Support, or Venue Administrator)
  • VenueID - Target venue identifier

Configuration Categories:

  • Identity: externalVenueID (64 chars), VenueName (40 chars, HTML sanitized)
  • Address: AddressLine1/2 (40 chars, HTML sanitized), City (40 chars), PostalCode (validated, unique)
  • Network Settings:
    • NAS-Identifier (253 chars, uppercase, unique within operator)
    • VLAN ranges (1-4095) for GlobalWirelessPlusLocalWiredAccess, LocalWirelessAccess, GlobalWirelessRoaming
    • WirelessOnlyPlanVLANOffset (VLAN offset for service plans with WirelessOnlyPlan set to true)
    • allowOverlappingSubscriptionWiredUnit (boolean)
    • Ruckus Cloud integration (URL, TenantID, APIClientID, APIClientSecret, DPSKPoolID)
    • GWError (clear with empty string "")
  • Service Plan Configuration: Default service plans for GlobalWirelessPlusLocalWiredAccess, LocalWirelessAccess, Roaming - validates service plan is available at venue
  • FCC Compliance: displayLabel (boolean), TypicalLatency (1-10000ms)
  • Notifications:
    • WelcomeEmail_countdown_hours (0-169)
    • suppressSubscriberEmails, sendSubscriptionAddedEmail, sendSubscriptionEndEmail, suppressSubscriberSMS
  • Integrations:
    • ConnectWise PSA: URL, Authorization (256 chars), serviceboardid (40 chars), ClientID (64 chars), CompanyID (64 chars)
    • PRTG Monitoring: URL, Username (40 chars), PasswordHash (256 chars)
  • Reporting: ReportingSubscriptionEnd_lookahead_hours (0-720), ReportingSubscriptionEnd_frequency_hours (0-720)
  • Property Management (PMS):
    • ProfileID (links to operator-level PMS profile)
    • RealPage: SiteId (property identifier, numeric)
    • Entrata: PropertyId (property identifier, numeric)
    • enableUnitSync (automatic unit synchronization from PMS)
    • enableSubscriberSync (automatic subscriber synchronization from PMS resident data)
  • Shopping Cart & Billing:
    • enableShoppingCart (boolean)
    • Stripe: StripePublishableKey (64 chars), Stripe_Secret_key (256 chars), Stripe_Webhook_signingsecret (256 chars), Stripe_allowrefund (boolean)
    • TrialCycleAdjustment (-1 to 1)
    • MaximumTrialCyclesPerSubscriber (-1 to 12)
    • MaximumFreeEnrollmentsPerSubscriber (-1 to 1000)
    • ShoppingCartPriceAdjustment (currency-specific, 0-100000)
  • Display Configuration: DisplayOptionID (links to display option templates)

Validation & Business Rules:

  • Partial Updates - Only provided fields are modified
  • HTML Sanitization - All text fields sanitized with validator library
  • Uniqueness Checks - Address and NAS-Identifier enforced within operator network
  • VLAN Validation - All VLAN ranges validated (1-4095)
  • Service Plan Validation - Service plan IDs validated via Neptune query (venue <-[serviceplan_offered_at_venue]- serviceplan)
  • URL Validation - All URL fields validated for proper format
  • Clear Fields - Use " " (space) to clear/remove optional fields (AddressLine2, externalVenueID)
  • Ruckus Cloud URLs - Must be one of: https://api.ruckus.cloud, https://api.eu.ruckus.cloud, https://api.asia.ruckus.cloud
  • Cascade Updates - Updates cascade to related entities (network policies, venue units, subscription intents, payment intents)

Regional Proxy Workflow:

  1. Field Mapping - Transform client field names to internal API format
  2. Redis Connection - Establish connection to regional Redis cluster for session management
  3. Input Validation - Validate request structure, AccessToken presence, JWT signature
  4. Role-Based Access Control - Verify user has required role for venue configuration
  5. Cross-Region Forward - POST to primary region gremlinconsole executeCommand
  6. Response Handling - Return sanitized response to API Gateway
  7. Error Notification - On uncaught exceptions, email development team with stack trace

Features:

  • Partial Updates - Only provided fields modified, no need to send entire configuration
  • Input Sanitization - All text fields HTML-sanitized with validator library
  • Uniqueness Enforcement - Address and NAS-Identifier uniqueness within operator network
  • Range Validation - VLAN ranges, latency, hours validated within acceptable ranges
  • Service Plan Validation - Verifies service plan offered at venue via relationship query
  • URL Format Validation - All URL fields validated for proper format and protocol
  • Field Clearing - Use " " (space string) to clear/remove optional fields
  • Regional Cloud Support - Ruckus URLs validated for US, EU, or Asia regions
  • Cascade Updates - Changes propagate to related entities (units, subscriptions, payments)
  • Audit Trail - All changes logged with timestamp and operator attribution
  • Gateway Error Reset - Clear gateway errors by setting GWError to empty string
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator access token for authentication

VenueID
required
string

Unique identifier of the venue to configure

externalVenueID
string <= 40 characters

External system venue identifier for integrations

VenueName
string <= 40 characters

Display name for the venue (HTML sanitized, 40 char max)

AddressLine1
string <= 40 characters

Primary street address (40 char max, triggers uniqueness check)

AddressLine2
string <= 40 characters

Secondary address line (40 char max, use " " to remove)

City
string <= 40 characters

City name (40 char max, HTML sanitized)

PostalCode
string

ZIP/postal code with international validation

object

Network-related configuration settings

object

Default service plan assignments for different access types

object

FCC network performance labeling configuration

object

Email and SMS notification preferences

object

Third-party system integration settings

object

Reporting configuration for subscription lifecycle events

object

Property Management System integration for automatic unit and subscriber synchronization. Supports RealPage and Entrata PMS platforms with venue-specific configuration.

object

E-commerce and billing configuration

DisplayOptionID
string

Display option template identifier for venue UI customization

deleteEmptyVenueUnits
boolean

Delete all venue units without active subscriptions. This bulk operation removes:

  • Empty venue units (units without active subscriptions)
  • Associated payment_intent records for deleted units
  • Associated logs and snapshot records
  • Updates venue units data

Units with active subscriptions (EndDateTimeUTC.ISO8601 in future) are protected unless forceDelete=true.

Error if occupied units exist and forceDelete=false: "Venue has X occupied unit(s)." with statusCode 401

forceDelete
boolean

Force deletion of units with active subscriptions by initiating asynchronous subscription cleanup.

Workflow when forceDelete=true:

  1. Identifies occupied units (units with active subscriptions)
  2. Initiates subscription deletion and gateway decommissioning
  3. Returns message instructing retry after equipment decommission completes
  4. Proceeds with immediate deletion of empty units

Requires retry pattern: Equipment decommissioning is asynchronous (takes several minutes). User must retry the deleteEmptyVenueUnits request after a few minutes to complete deletion once subscriptions are ended and gateways decommissioned.

Only valid when deleteEmptyVenueUnits=true. Has no effect otherwise.

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_67890",
  • "externalVenueID": "HOTEL_001",
  • "VenueName": "Downtown Business Hotel",
  • "AddressLine1": "123 Main Street",
  • "AddressLine2": "Suite 100",
  • "City": "New York",
  • "PostalCode": "10001",
  • "NetworkConfiguration": {
    },
  • "ServicePlanConfiguration": {
    },
  • "FCCLabel": {
    },
  • "Notifications": {
    },
  • "Integrations": {},
  • "Reporting": {
    },
  • "PMS": {
    },
  • "ShoppingCart": {
    },
  • "DisplayOptionID": "display_option_123"
}

Response samples

Content type
application/json
Example
{
  • "message": "Updated externalVenueID = HOTEL_001. Updated VenueName = Downtown Business Hotel. Updated AddressLine1 = 123 Main Street. Updated AddressLine2 = Suite 100. Updated City = New York. Updated PostalCode = 10001. Updated NAS-Identifier = HOTEL.DOWNTOWN.NYC. Updating MinimumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess to 100. Updating MaximumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess to 200. Updating MinimumAutoGeneratedVLAN_LocalWirelessAccess to 300. Updating MaximumAutoGeneratedVLAN_LocalWirelessAccess to 400. Updated Ruckus.URL = https://api.ruckus.cloud. Updated Ruckus.TenantID = tenant_abc123. Updated Ruckus.APIClientID = client_xyz789. Updated Ruckus.APIClientSecret = secret_key_here. Updated Ruckus.DPSKPoolID = dpsk_pool_456. Updated DefaultServicePlanID_GlobalWirelessPlusLocalWiredAccess - plan_global_123. Updated DefaultServicePlanID_LocalWirelessAccess - plan_local_456. Updated DefaultServicePlanID_Roaming - plan_roaming_789. Updating FCCLabel.displayLabel to true. Updating FCCLabel.TypicalLatency to 25 millisecond(s). Updating WelcomeEmail_countdown_hours to 24. Updating suppressSubscriberEmails to false. Updating sendSubscriptionAddedEmail to true. Updating sendSubscriptionEndEmail to true. Updating suppressSubscriberSMS to false. Updated Integrations.ConnectWise.URL = https://your-instance.connectwise.com. Updated ConnectWiseAuthorization = Basic dXNlcjpwYXNz. Updated ConnectWiseserviceboardid = ServiceBoard1. Updated ConnectWiseClientID = client123. Updated ConnectWiseCompanyID = company456. Updated Integrations.PRTG.URL = https://prtg.example.com. Updated PRTGUsername = prtguser. Updated PRTGPasswordHash. Updating ReportingSubscriptionEnd_lookahead_hours to 168. Updating ReportingSubscriptionEnd_frequency_hours to 24. Updated RealPagePMCId to 12345. Updated RealPageSiteId to 67890. Updating enableRealPageSync to true. Updating enableShoppingCart to true. Updated StripePublishableKey = pk_test_.... Updated Stripe_Secret_key = sk_test_.... Updated Stripe_Webhook_signingsecret = whsec_.... Updating Stripe_allowrefund to false. Updating TrialCycleAdjustment to 0. Updating MaximumTrialCyclesPerSubscriber to 1. Updating MaximumFreeEnrollmentsPerSubscriber to 3. Updating ShoppingCartPriceAdjustment.USD to 0. Updated DisplayOptionID = display_option_123.",
  • "errorProcessing": false
}

/networkoperatorconsole/venues/addPRTGCredentials

Configure PRTG (Paessler Router Traffic Grapher) monitoring system integration for venue-specific network equipment monitoring.

⚠️ Deprecated: Sunset date 2040-12-30.

Required Parameters:

  • AccessToken - Network operator authentication (domain administrator privileges)
  • PRTG Server URL - PRTG server endpoint
  • Username - PRTG authentication username
  • Password Hash - Encrypted password
  • Group Configuration - PRTG group settings

Monitoring Capabilities:

  • Wireless controllers
  • CMTS systems
  • OLT devices
  • G.hn headend equipment

Features:

  • Real-time status tracking (UP/DOWN/UNUSUAL)
  • Performance metrics collection
  • Automated alerting
  • Multiple PRTG servers support
  • Encrypted credential storage
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

VenueID
required
string

Unique venue identifier for PRTG integration configuration

required
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345",
  • "Integrations": {}
}

Response samples

Content type
application/json
{
  • "message": "PRTG monitoring integration configured successfully",
  • "VenueID": "venue_12345",
  • "monitoring_status": "enabled",
  • "integration_details": {}
}

/networkoperatorconsole/venues/addVenueEquipment

Register new network equipment at venue with automatic configuration. Creates equipment node and immediately configures settings via configureVenueEquipment.

Required Parameters:

  • AccessToken - Network operator domain administrator authentication via Cognito
  • VenueID - Target venue identifier
  • EquipmentID - Unique equipment identifier within venue
  • ConnectionProtocol - Communication protocol (http or https)
  • IPAddress - Equipment IP address (IPv4 or IPv6)
  • Port - Network communication port (1-65535)
  • Username - Equipment management username (max 64 characters)
  • Password - Equipment management password (max 100 characters)

Optional Configuration:

  • Manufacturer - Equipment manufacturer name (max 20 chars, HTML-sanitized)
  • Model - Equipment model designation (max 20 chars, HTML-sanitized)
  • EquipmentType - Equipment classification (max 20 chars, HTML-sanitized)
  • WirelessZone - Wireless zone assignment
  • MikrotikPre643 - Compatibility flag for MikroTik pre-6.43 versions

Equipment Limits:

  • General Equipment: Maximum 5000 equipment per venue
  • Gateway Equipment: Maximum 3 gateways per venue

Behavior:

  • Creates equipment vertex with generated EquipmentID_internal (VenueID._V3EQUIPMENT.EquipmentID)
  • Automatically calls configureVenueEquipment to apply all provided settings
  • Returns error if equipment already exists
  • Logs equipment addition with administrator details
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Cognito authentication token for network operator domain administrator access

VenueID
required
string

Venue identifier where equipment will be registered

EquipmentID
required
string

Unique equipment identifier within venue

ConnectionProtocol
required
string
Enum: "http" "https"

Communication protocol for equipment management interface

IPAddress
required
string

Equipment management IP address (IPv4 or IPv6 format)

Port
required
integer [ 1 .. 65535 ]

Network communication port for equipment management

Username
required
string <= 64 characters

Equipment management interface username

Password
required
string <password> <= 100 characters

Equipment management interface password

Manufacturer
string <= 20 characters

Equipment manufacturer name (HTML tags removed, trimmed)

Model
string <= 20 characters

Equipment model designation (HTML tags removed, trimmed)

EquipmentType
string <= 20 characters

Equipment classification (HTML tags removed, trimmed)

WirelessZone
string

Optional wireless zone assignment

MikrotikPre643
boolean

Compatibility flag for MikroTik RouterOS versions before 6.43

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "VenueID": "venue_12345",
  • "EquipmentID": "GW-MAIN-01",
  • "ConnectionProtocol": "https",
  • "IPAddress": "192.168.1.100",
  • "Port": 8728,
  • "Username": "admin",
  • "Password": "SecurePass123!",
  • "Manufacturer": "MikroTik",
  • "Model": "CCR1036",
  • "EquipmentType": "gateway",
  • "WirelessZone": "Building-A",
  • "MikrotikPre643": false
}

Response samples

Content type
application/json
{
  • "EquipmentID_internal": "venue_12345._V3EQUIPMENT.GW-MAIN-01",
  • "message": "Equipment added successfully. Gateway configured successfully."
}

/networkoperatorconsole/venues/updateVenueEquipment

⚠️ API Alias: This endpoint is an alias for /networkoperatorconsole/venues/configureVenueEquipment. Please refer to that endpoint for complete documentation, parameters, and examples.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
object

See /networkoperatorconsole/venues/configureVenueEquipment for schema

Responses

Request samples

Content type
application/json
{ }

/networkoperatorconsole/admin/deleteVenueEquipmentPermanently

Permanently remove network equipment from venue inventory and decommission configurations.

⚠️ WARNING: Equipment removal may impact network performance and connectivity.

Required Parameters:

  • AccessToken - Administrative authorization
  • VenueID - Target venue identifier
  • EquipmentID - Equipment identifier to delete
  • DeletionReason - Business justification for removal
  • Confirmation Code - Equipment-specific confirmation code

Data Removed:

  • Equipment inventory and asset records
  • Network configurations
  • Performance metrics
  • Maintenance history
  • Warranty information
  • Monitoring configurations

Supported Equipment Types:

  • Access points and Wi-Fi routers
  • Network switches and routers
  • Gateways and security appliances
  • Network monitoring tools

Optional Features:

  • Configuration backup for replacement equipment
  • Scheduled removal for planned maintenance
  • Tenant/manager notifications
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrative privileges

VenueID
required
string

Parent venue identifier containing the target equipment

EquipmentID
required
string

Specific equipment identifier for targeted deletion

DeletionReason
required
string
Enum: "EquipmentFailure" "TechnologyUpgrade" "VenueRestructuring" "CostOptimization" "MaintenanceReplacement"

Business justification for equipment removal

ConfirmationCode
required
string^DELETE-EQUIP-[A-Z0-9]{4}$

Security confirmation code to verify intentional equipment deletion (format: DELETE-EQUIP-XXXX)

PreserveConfiguration
boolean
Default: true

Option to preserve equipment configuration for replacement device

ScheduledRemovalDate
string <date-time>

Optional scheduled removal date for planned maintenance

ReplacementEquipmentID
string

Identifier of replacement equipment for seamless transition

object
MaintenanceDocumentation
string

Equipment condition and maintenance notes for asset management

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "VENUE_12345",
  • "EquipmentID": "AP_CISCO_001",
  • "DeletionReason": "EquipmentFailure",
  • "ConfirmationCode": "DELETE-EQUIP-G7H8",
  • "PreserveConfiguration": true,
  • "ReplacementEquipmentID": "AP_CISCO_002",
  • "NotificationPreferences": {
    },
  • "MaintenanceDocumentation": "Access point failed after power surge - RMA case #12345 submitted to Cisco"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "deletionId": "EQUIP_DEL_987654321",
  • "equipment": {
    },
  • "configurationBackup": {
    },
  • "networkImpact": {
    },
  • "replacement": {
    },
  • "audit": {
    },
  • "notifications": {
    }
}

/networkoperatorconsole/subscribers/modifyServicePlan

Change subscriber service plans with automated billing and feature updates.

Required Parameters:

  • AccessToken - Network operator authentication
  • SubscriberID - Target subscriber identifier
  • NewServicePlan - New plan configuration (PlanID, PlanName, MonthlyRate, BandwidthLimit with Download/Upload Mbps, Features)
  • EffectiveDate - When plan change takes effect
  • BillingAction - Billing handling (PRORATE/FULL_CYCLE/CREDIT_ONLY/NO_CHARGE)

Plan Change Types:

  • Upgrades to higher-tier plans
  • Downgrades for cost savings
  • Lateral changes to different feature combinations
  • Custom plans and promotional offers

Optional Parameters:

  • ReasonCode - Change justification (UPGRADE_REQUEST/DOWNGRADE_REQUEST/RETENTION/PROMOTION/TECHNICAL_REQUIREMENT/COST_OPTIMIZATION)
  • PromoCode - Special pricing application
  • CustomFeatures - Additional features with charges
  • NotificationPreferences - Customer notification settings
  • BillingOverride - Manual billing adjustments

Features:

  • Automated prorated billing calculations
  • Instant bandwidth/feature activation
  • Customer notifications
  • Revenue impact tracking
  • Network configuration updates
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber management privileges

SubscriberID
required
string

Target subscriber identifier for service plan modification

required
object
EffectiveDate
required
string <date-time>

Service plan change effective date

BillingAction
required
string
Enum: "PRORATE" "FULL_CYCLE" "CREDIT_ONLY" "NO_CHARGE"

Billing action for service plan change

ReasonCode
string
Enum: "UPGRADE_REQUEST" "DOWNGRADE_REQUEST" "RETENTION" "PROMOTION" "TECHNICAL_REQUIREMENT" "COST_OPTIMIZATION"

Business reason for service plan change

PromoCode
string

Optional promotional code for special pricing

Array of objects
object
object

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "NewServicePlan": {
    },
  • "EffectiveDate": "2025-09-15T00:00:00Z",
  • "BillingAction": "PRORATE",
  • "ReasonCode": "UPGRADE_REQUEST",
  • "NotificationPreferences": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "planChangeId": "PLAN_CHG_987654321",
  • "subscriber": {
    },
  • "billing": {
    },
  • "features": {
    },
  • "notifications": {
    },
  • "audit": {
    }
}

/networkoperatorconsole/subscribers/updateSubscriberPII

Update personally identifiable information (PII) for subscribers with privacy protection and compliance support.

⚠️ Restrictions: Cannot update SSO-managed subscribers. Externally managed PII data may be read-only. Email uniqueness is enforced system-wide.

Required Parameters:

  • AccessToken - Domain administrator with subscriber management privileges

Updatable Fields:

  • SubscriberToken - Subscriber identifier
  • EmailAddress - Email (must be unique across system)
  • PhoneNumber - Phone in E.164 format with country code
  • GivenName - First name
  • FamilyName - Last name
  • Status - Account status (In Service/AUP Not Accepted)
  • newExternalSubscriberID - External system integration identifier

Features:

  • Secure PII handling with encryption
  • Complete audit logging of modifications
  • GDPR/CCPA compliance support
  • Network operator authorization
  • Cognito user pool synchronization
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Domain administrator access token with subscriber management privileges

SubscriberToken
string

Unique subscriber identifier for PII updates

EmailAddress
string <email>

Primary email address for subscriber communication

PhoneNumber
string

E.164 formatted phone number with country code

GivenName
string

Subscriber's first name or given name

FamilyName
string

Subscriber's last name or family name

Status
string
Enum: "In Service" "AUP Not Accepted"

Subscriber account status for service management

newExternalSubscriberID
string

New external system identifier for subscriber mapping

locale
string
Enum: "en-us" "es-xl"

Subscriber's preferred language and locale setting

contactpref_sms
boolean

SMS communication preference setting

contactpref_email
boolean

Email communication preference setting

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberToken": "5978d2e8-9540-4612-816f-1d14f6ba38e8",
  • "EmailAddress": "john.smith.updated@example.com",
  • "PhoneNumber": "+12345678901",
  • "GivenName": "John",
  • "FamilyName": "Smith",
  • "Status": "In Service",
  • "contactpref_sms": true,
  • "contactpref_email": true
}

Response samples

Content type
application/json
{
  • "message": "Updating GivenName=John. Updating Status= In Service. PII updated successfully.",
  • "errorProcessing": false
}

/networkoperatorconsole/subscribers/getSubscriberEmail

Retrieve subscriber email addresses, verification status, communication preferences, and email delivery analytics.

Required Parameters:

  • AccessToken - Network operator with subscriber information privileges
  • SubscriberID - Target subscriber identifier

Optional Parameters:

  • IncludeHistory - Include communication analytics
  • VerificationDetails - Include verification timeline
  • CommunicationPreferences - Include notification settings
  • DeliveryAnalytics - Include engagement metrics (delivery success rate, bounce rate, open rates, click-through rates, spam reports)
  • DateRange - Filter historical data

Returns:

  • Email addresses list (primary/secondary/business/recovery)
  • Verification status with domain verification for business accounts
  • Security status and last verification timestamp
  • Verification method
  • Communication settings and verification history
  • Delivery analytics

Features:

  • Network operator domain administrator access control
  • Cognito authentication
  • GDPR-compliant privacy protection
  • Data minimization
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with subscriber information privileges

SubscriberID
required
string

Target subscriber identifier for email information retrieval

IncludeHistory
boolean
Default: false

Include email communication history and analytics

VerificationDetails
boolean
Default: true

Include detailed email verification status and history

CommunicationPreferences
boolean
Default: true

Include complete communication preference settings

DeliveryAnalytics
boolean
Default: false

Include email delivery metrics and engagement analytics

object

Historical data range for analytics

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SubscriberID": "SUB_123456789",
  • "IncludeHistory": true,
  • "VerificationDetails": true,
  • "CommunicationPreferences": true,
  • "DeliveryAnalytics": true,
  • "DateRange": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "subscriber": {
    },
  • "emailInformation": {
    },
  • "verification": {
    },
  • "communicationPreferences": {
    },
  • "deliveryAnalytics": {
    },
  • "communicationHistory": [
    ],
  • "audit": {
    }
}

/networkoperatorconsole/equipment/listEquipmentLog

Retrieves comprehensive activity and event logs for specific network equipment, providing detailed operational history, configuration changes, and administrative actions.

Use Cases:

  • Monitor equipment health
  • Track configuration modifications
  • Audit administrative activities
  • Troubleshoot operational issues

Log Categories:

  • Gateway configurations
  • VLAN operations
  • Port management
  • Authentication state changes

Features:

  • Full audit trail capabilities
  • Detailed operational history
  • Administrative action tracking
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrative access token with NetworkOperator domain administrator privileges required for equipment log access

EquipmentID
required
string

Unique identifier of the network equipment whose activity logs will be retrieved. Must be equipment within the operator's managed infrastructure.

Responses

Request samples

Content type
application/json

Request to retrieve complete activity logs for specified network equipment

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "EquipmentID": "equipment_12345678-90ab-cdef-1234-567890abcdef"
}

Response samples

Content type
application/json

Complete activity log showing VLAN configuration changes and port operations

{
  • "message": "",
  • "Status": "In Service",
  • "EquipmentID": "equipment_12345678-90ab-cdef-1234-567890abcdef",
  • "EquipmentName": "GW-001-Main",
  • "EquipmentType": "Gateway",
  • "Manufacturer": "Mikrotik",
  • "Model": "CCR1009-7G-1C-1S+",
  • "ConnectionProtocol": "api",
  • "IPAddress": "192.168.1.1",
  • "log": [
    ]
}

/networkoperatorconsole/equipment/listEquipmentErrorLog

Specialized error monitoring and diagnostic system for network equipment error detection and analysis.

Required Parameters:

  • AccessToken - Network operator authentication with equipment monitoring privileges
  • VenueID - Target venue identifier

Error Monitoring:

  • Filters exclusively for error-level events
  • 3-day lookback window for focused problem identification
  • Monitors vault_networkoperator_equipmentConfigurator function

Monitored Error Categories:

  • Gateway Configuration Failures: VLAN creation/modification/deletion, port authentication state changes, network interface issues, bandwidth queue failures, hotspot/captive portal errors
  • Network Connectivity Issues: Gateway communication timeouts, RADIUS authentication failures, API response errors, DHCP/routing problems
  • Hardware Faults: Equipment malfunctions, performance degradation, physical interface problems, power/environmental alerts

Error Details Provided:

  • Equipment Context: Type, manufacturer, model, operational status, IP address
  • Venue Information: VenueID, UnitID_internal
  • Failure Analysis: Gateway response codes (FAILED/FAIL status), original request context
  • Diagnostic Information: ChangeAuthStatus, PortSpeedStatus, Command, PORT, creation flags (BandwidthQueue/Interface/HotSpot/DHCPServer)

Use Cases:

  • Proactive problem detection with trend analysis for recurring issues
  • Preventive maintenance indicators and capacity planning insights
  • Rapid incident response with root cause analysis capabilities
  • Real-time equipment health monitoring for network operations centers
  • Technical support diagnostics and infrastructure planning
  • Vendor performance evaluation
  • Compliance reporting and SLA management

Features:

  • Cognito authentication with venue-level access control
  • Audit trail compliance
  • Secure handling of equipment configuration data
  • Optimized error-only filtering for high-performance retrieval
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with equipment monitoring privileges

VenueID
required
string

Venue identifier for venue-specific equipment error filtering

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_ABC123"
}

Response samples

Content type
application/json
{
  • "message": "Found 12 equipment error events in the past 3 days",
  • "Errors": [
    ]
}

/networkoperatorconsole/equipment/listPendingGatewayVLANDisable

Comprehensive VLAN disable queue management system for tracking and coordinating pending VLAN disable operations for expired subscriptions.

Purpose:

  • Provides visibility into subscriber service termination queue
  • Coordinates gateway processes across distributed gateway infrastructure

Tracked Operations:

  • Expired Subscription Processing: Natural expiration, administrative termination, payment failure suspension, policy violation, service change transitions
  • Gateway Coordination: Multi-gateway environments, primary gateway validation, backup gateway failover, load balancing
  • Policy Management: Disable policy creation, status tracking, priority queue management, batch processing, rollback support

Returns:

  • Subscription Context: SubscriptionID, VenueID, UnitID_internal, subscriptionType, terminationReason (EXPIRED/PAYMENT_FAILURE/ADMINISTRATIVE/POLICY_VIOLATION/SERVICE_CHANGE)
  • Equipment Information: EquipmentID, type, manufacturer, model, IP address, gatewayStatus (ONLINE/OFFLINE/MAINTENANCE)
  • Policy Status: policyStatus (QUEUED/PROCESSING/PENDING_GATEWAY/READY_FOR_EXECUTION)
  • Processing Details: Priority (LOW/NORMAL/HIGH/URGENT), VLAN port number, expiration/queued timestamps, estimated execution time, retry count

Features:

  • Chronological queue processing by venue
  • Equipment availability filtering and subscription validation
  • Automated termination processing with batch efficiency
  • Resource optimization and timeline compliance for SLA adherence
  • Cognito authentication with venue-level access control
  • Operation audit trail and secure handling of subscriber/gateway data

Business Integration:

  • Billing systems integration
  • Customer service visibility
  • Compliance reporting
  • Revenue protection through timely service termination
  • High-volume processing with intelligent load distribution
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with VLAN management privileges

VenueID
required
string

Venue identifier for venue-specific VLAN disable queue filtering

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_DEF456"
}

Response samples

Content type
application/json
{
  • "message": "Found 8 pending VLAN disable operations",
  • "PendingDisableOperations": [
    ]
}

/networkoperatorconsole/equipment/listPendingGatewayVLANEnable

Monitors and manages pending gateway VLAN enable operations within the network operator's infrastructure.

Purpose:

  • Provides visibility into scheduled service activations awaiting gateway configuration
  • Enables proactive management of subscriber onboarding
  • Tracks network capacity expansion

Features:

  • Tracks subscription intents created but not yet provisioned on gateway equipment
  • Identifies potential bottlenecks in service delivery workflows
  • Enables proactive service activation management
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Administrative access token with NetworkOperator domain administrator privileges required for VLAN queue management

Responses

Request samples

Content type
application/json

Request to retrieve all pending VLAN enable operations across the network

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
Example

Multiple subscription intents awaiting gateway VLAN configuration

{
  • "message": "",
  • "SubscriptionCount": 3,
  • "Subscriptions": [
    ]
}

/networkoperatorconsole/webhooks/listWebhookLog

Monitor webhook activity logs, track integration events, and analyze webhook delivery status across network operations.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with webhook monitoring privileges

VenueID
required
string

Venue identifier for venue-specific webhook activity filtering

MinViewWindowDateUTC.ISO8601
string <date-time>

Start date for webhook activity analysis (defaults to 24 hours ago)

MaxViewWindowDateUTC.ISO8601
string <date-time>

End date for webhook activity analysis (defaults to current time)

Type
Array of strings

Filter by specific webhook event types

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_GHI789",
  • "MinViewWindowDateUTC.ISO8601": "2025-09-11T19:35:00Z",
  • "MaxViewWindowDateUTC.ISO8601": "2025-09-12T19:35:00Z",
  • "Type": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "24 webhooks found.",
  • "Webhooks": [
    ]
}

/networkoperatorconsole/scratchcards/addScratchCards

Comprehensive scratch card batch creation system for generating cryptographically secure prepaid internet access codes with distributed Lambda-based processing. Supports high-volume generation of 100-card batches with flexible validity period configuration and WPA2/WPA3 enterprise authentication integration.

Required Parameters:

  • AccessToken - Cognito authentication with scratch card creation privileges
  • VenueID - Venue-specific batch creation
  • KeyPoolID - Keypool association for organized storage

Optional Parameters:

  • ScratchCard_BatchID - Custom batch ID (defaults to timestamp-based tracking)
  • UserPartofKey - Custom prefix for branded access codes (0-20 characters)
  • StartDateTimeUTC.ISO8601 - Batch validity start date (up to 90-day advance scheduling)
  • EndDateTimeUTC.ISO8601 - Batch validity end date (UTC-based time management)

Security Features:

  • PBKDF2-based PSK generation with SHA-1 hashing
  • Dictionary-word subscriber token generation (dual-word combination for memorability)
  • Collision detection for unique code generation
  • 32-byte PMK calculation optimized for wireless security standards
  • Encrypted key storage with secure keypool bin management

Returns:

  • Asynchronous batch creation initiation with ScratchCard_BatchID for tracking
  • Batch details including size (100 cards) and validity period configuration
  • Key configuration (keyPoolID, userPrefix, encryptionMethod)
  • Retrieval endpoint reference (viewScratchCardBatch)

Use Cases:

  • Venue access solutions (hotels, retail, events, education)
  • Revenue generation through prepaid services
  • Promotional campaigns and gift card programs
  • Partner distribution networks

Features:

  • Scalable auto-scaling Lambda architecture with non-blocking background processing
  • Real-time progress monitoring and comprehensive error handling
  • Complete audit trail with keypool-based role-based access control
  • Business intelligence (generation success rates, distribution analytics, revenue tracking)
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with scratch card creation privileges

VenueID
required
string

Venue identifier for venue-specific scratch card batch creation

KeyPoolID
required
string

Keypool identifier for access code storage and organization

ScratchCard_BatchID
string <date-time>

Optional batch identifier (defaults to current timestamp)

StartDateTimeUTC.ISO8601
string <date-time>

Access validity start date (defaults to current time, max 90 days in future)

EndDateTimeUTC.ISO8601
string <date-time>

Access validity end date (required for validity window)

UserPartofKey
string [ 0 .. 20 ] characters

Optional custom prefix for access codes (auto-generated if not provided)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_JKL012",
  • "KeyPoolID": "keypool_ABC123",
  • "StartDateTimeUTC.ISO8601": "2025-09-12T20:00:00Z",
  • "EndDateTimeUTC.ISO8601": "2025-09-15T20:00:00Z",
  • "UserPartofKey": "HOTEL2025"
}

Response samples

Content type
application/json
{
  • "message": "Generating scratch cards. Download scratch cards using /networkoperatorconsole/scratchcards/viewScratchCardBatch.",
  • "ScratchCard_BatchID": "2025-09-12T19:35:00.123Z",
  • "batchDetails": {
    }
}

/networkoperatorconsole/scratchcards/viewScratchCardBatch

Retrieve comprehensive scratch card batch information including individual card status, usage analytics, and validity periods for inventory management and business performance tracking.

Required Parameters:

  • AccessToken - Cognito authentication with operator privileges
  • KeyPoolID - Keypool association for venue-specific batches
  • ScratchCard_BatchID - ISO 8601 timestamp-based unique batch identifier

Returns - Batch Configuration:

  • Batch identification with timestamp tracking
  • Keypool association and network SSID configuration
  • Validity windows with start/end dates

Returns - Individual Card Information:

  • Pre-shared keys (PSK) for WiFi authentication
  • Network SSID associations
  • Validity period start/end dates
  • Invalidation status for manually disabled cards
  • Usage status indicating activation

Returns - Business Intelligence Data:

  • Utilization patterns and revenue tracking
  • Distribution analytics
  • Performance metrics for batch effectiveness
  • Customer adoption analytics

Use Cases:

  • Inventory management for tracking distribution levels
  • Revenue analysis for prepaid access program performance
  • Customer analytics for adoption patterns and preferences
  • Promotional effectiveness evaluation for marketing campaigns
  • Vendor relations data for partner venue relationships
  • Compliance reporting with audit trail

Features:

  • Real-time visibility into current batch status
  • Performance monitoring for effectiveness tracking
  • Batch-level access control restricted to operator scope
  • Secure inventory information with protected business data security
  • Automatic filtering by network operator permissions and scope
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token for batch access

KeyPoolID
required
string

Unique identifier for the key pool associated with the scratch card batch

ScratchCard_BatchID
required
string <date-time>

Unique batch identifier (ISO 8601 timestamp) for the scratch card batch

Responses

Request samples

Content type
application/json
Example

Query scratch card batch for hotel guest access program

{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.hotel_operator_token",
  • "KeyPoolID": "pool_grandhotel_guestaccess",
  • "ScratchCard_BatchID": "2023-09-15T14:30:00.000Z"
}

Response samples

Content type
application/json
Example

Detailed batch information for hotel guest access cards

{
  • "2023-09-15T14:30:00.000Z": {
    }
}

/networkoperatorconsole/equipment/listOperatorLog

Retrieve network operator activity logs for administrative actions, configuration changes, and system events.

Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator access token for authentication

MaxViewWindowDateUTC.ISO8601
string <date-time>

End date for log retrieval window (defaults to current time)

MinViewWindowDateUTC.ISO8601
string <date-time>

Start date for log retrieval window (defaults to 24 hours ago)

function_name
string

Filter logs by specific function name

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Response samples

Content type
application/json
Example
{
  • "log": [
    ],
  • "log_count": 156,
  • "log_returned": 2
}

/networkoperatorconsole/equipment/removeRADIUSServer

Safely remove RADIUS authentication server from network operator's infrastructure with proper validation and data consistency measures.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator access token for authentication

RadiusServerIP
required
string <ipv4>

IP address of the RADIUS server to remove

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "RadiusServerIP": "192.168.1.10"
}

Response samples

Content type
application/json
{
  • "Success": "Removed RadiusServerIP. ",
  • "RadiusServerIP": "192.168.1.10"
}

/networkoperatorconsole/equipment/configureTandC

Configure and manage terms and conditions documents for network operator services with multi-locale support and content management.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator access token for authentication

locale
required
string
Enum: "en-us" "es-xl"

Target locale for the Terms and Conditions content

TandC
required
string

Terms and Conditions content (HTML allowed, scripts will be sanitized)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  • "locale": "en-us",
  • "TandC": "<h2>Terms of Service</h2><p>By using this WiFi service, you agree to comply with all applicable laws and regulations...</p>"
}

Response samples

Content type
application/json
Example
{
  • "TandC.en-us": "<h2>Terms of Service</h2><p>By using this WiFi service, you agree to comply with all applicable laws and regulations...</p>"
}

/networkoperatorconsole/equipment/addServicePlan

Administrative endpoint for network operators to create new service plans with bandwidth specifications, concurrent device limits, and billing cycle configuration.

Required Parameters:

  • AccessToken - Cognito authentication with domain administrator or network software provider privileges
  • ServicePlanName - Max 256 characters (used to generate ServicePlanID)
  • UploadKbps - Bandwidth limit (1-100000000000000 range with automatic correction)
  • DownloadKbps - Bandwidth limit (1-100000000000000 range with automatic correction)
  • ConcurrentDevices - Device limit (1-10000 range with automatic correction, defaults to 10000)

Optional Parameters:

  • ServicePlanDescription - Max 256 characters (automatically enhanced with billing cycle info)
  • BillingCycleHours - Billing period (1-730.5 hours with automatic correction, adds description suffix)
  • WirelessOnlyPlan - Boolean flag indicating if plan is wireless-only (i.e. the plan does not offer access to wired ports, defaults to false). Requires WirelessOnlyPlanVLANOffset for venue level configuration.
  • OperatorID - Required only for Network Software Provider access specifying target operator

Processing:

  • Validates access token and administrative privileges through Cognito
  • Verifies domain administrator or network software provider credentials
  • Validates required fields with automatic range corrections
  • Checks service plan name uniqueness within operator network
  • Ensures operator has not exceeded 500 service plan limit
  • Creates service plan profile with auto-generated ServicePlanID
  • Establishes operator relationship and records creation event
  • Automatically calls configureServicePlan for advanced settings
  • Updates synchronized data for immediate availability

Returns:

  • Auto-generated ServicePlanID
  • Success message with plan details
  • Configuration results from automatic configureServicePlan call

Features:

  • Complete audit trail with administrator identification and timestamps
  • Service plan ownership scoping to authenticated operator
  • Alternative Network Software Provider access for multi-operator management
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Valid Cognito authentication token for domain administrator or network software provider

ServicePlanName
required
string <= 256 characters

Descriptive name for the service plan - used to generate ServicePlanID

ServicePlanDescription
string <= 256 characters

Optional detailed description of service plan features (automatically enhanced with billing cycle info)

UploadKbps
required
integer [ 1 .. 100000000000000 ]

Upload bandwidth limit in Kbps (automatically corrected to 1-100000000000000 range)

DownloadKbps
required
integer [ 1 .. 100000000000000 ]

Download bandwidth limit in Kbps (automatically corrected to 1-100000000000000 range)

ConcurrentDevices
required
integer [ 1 .. 10000 ]

Maximum concurrent device connections per subscriber (automatically corrected to 1-10000 range)

BillingCycleHours
number [ 1 .. 730.5 ]

Billing cycle duration in hours (automatically corrected to 1-730.5 range, adds description suffix)

WirelessOnlyPlan
boolean
Default: false

Indicates if this service plan is restricted to wireless-only access (no wired network access)

OperatorID
string

Required only for Network Software Provider access - specifies target operator

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "ServicePlanName": "Basic Home Internet",
  • "ServicePlanDescription": "Reliable internet for everyday use",
  • "UploadKbps": 25000,
  • "DownloadKbps": 100000,
  • "ConcurrentDevices": 10,
  • "BillingCycleHours": 720
}

Response samples

Content type
application/json
{
  • "ServicePlanID": "OPERATOR456._V3SERVICEPLAN_.BASICHOMEINTERNET",
  • "message": "Plan added: OPERATOR456._V3SERVICEPLAN_.BASICHOMEINTERNET - 25000 UP / 100000 DOWN - 10 concurrent devices per subscriber. Service plan configured successfully."
}

/networkoperatorconsole/equipment/configureServicePlan

Service plan configuration update endpoint for network operators to modify existing service plan parameters.

Required Parameters:

  • AccessToken - Cognito domain administrator or network software provider authentication
  • ServicePlanID - Identifies the service plan to configure

Updatable Configuration:

  • Bandwidth Settings - UploadKbps/DownloadKbps (1-100000000000000 Kbps range)
  • Device Limits - ConcurrentDevices (1-10000)
  • Display Properties - ServicePlanName (max 40 chars), ServicePlanDescription (max 256 chars)
  • Multi-Currency Pricing - BillingCyclePrice in cents/paise/fen (USD/EUR/GBP/CAD/AUD/CNY/INR/LKR, 0-1200000 range)
  • Availability Controls - GloballyAvailablePlan, AllowSelfSignup (booleans)
  • Network Access Type - WirelessOnlyPlan (i.e. the plan does not offer access to wired ports, defaults to false). Requires WirelessOnlyPlanVLANOffset for venue level configuration.
  • External Integration - externalServicePlanID (max 64 chars), SMSCode (max 6 chars, use " " to remove)
  • Subscription Migration - migrateToServicePlan (must match billing cycle)
  • FCC Compliance - FCCLabel (PlanID starting 'F', max 40 chars), TypicalUploadKbps/TypicalDownloadKbps, policy URLs (Privacy/NetworkMgmt/Data/BundleDiscount/Support, use "" to remove)

Processing:

  • Cognito authentication and validation
  • Domain admin or NSP authorization verification
  • ServicePlanID parameter validation
  • Service plan ownership verification
  • Forward to master data service for distributed configuration update

Returns:

  • Detailed success message with field-by-field update details
  • ServicePlanID confirmation
  • Status code 200 with errorProcessing boolean

Features:

  • Comprehensive audit logging with administrator identification
  • Regional write access control for data integrity
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid Cognito authentication token for domain administrator or network software provider

ServicePlanID
required
string

Unique identifier for the service plan to configure

ServicePlanName
string <= 40 characters

Display name for the service plan (max 40 characters)

ServicePlanDescription
string <= 256 characters

Description of the service plan (max 256 characters)

UploadKbps
integer [ 1 .. 100000000000000 ]

Upload bandwidth limit in kilobits per second

DownloadKbps
integer [ 1 .. 100000000000000 ]

Download bandwidth limit in kilobits per second

ConcurrentDevices
integer [ 1 .. 10000 ]

Maximum concurrent devices allowed per subscriber

BillingCyclePrice.USD
integer [ 0 .. 1200000 ]

Billing cycle price in US dollars (cents)

BillingCyclePrice.EUR
integer [ 0 .. 1200000 ]

Billing cycle price in Euros (cents)

BillingCyclePrice.GBP
integer [ 0 .. 1200000 ]

Billing cycle price in British Pounds (pence)

BillingCyclePrice.CAD
integer [ 0 .. 1200000 ]

Billing cycle price in Canadian Dollars (cents)

BillingCyclePrice.AUD
integer [ 0 .. 1200000 ]

Billing cycle price in Australian Dollars (cents)

BillingCyclePrice.CNY
integer [ 0 .. 1200000 ]

Billing cycle price in Chinese Yuan (fen)

BillingCyclePrice.INR
integer [ 0 .. 1200000 ]

Billing cycle price in Indian Rupees (paise)

BillingCyclePrice.LKR
integer [ 0 .. 1200000 ]

Billing cycle price in Sri Lankan Rupees (cents)

GloballyAvailablePlan
boolean

Whether the plan is globally available

AllowSelfSignup
boolean

Whether subscribers can self-signup for this plan

externalServicePlanID
string <= 64 characters

External service plan identifier (max 64 characters, use " " to remove)

SMSCode
string <= 6 characters

SMS code for the plan (max 6 characters, use " " to remove)

migrateToServicePlan
string

Service plan ID to migrate existing subscriptions to (must have same billing cycle)

object

FCC label information for regulatory compliance

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "ServicePlanID": "OP001._V3SERVICEPLAN_.PREMIUM",
  • "ServicePlanName": "Premium Internet Plan",
  • "ServicePlanDescription": "High-speed internet with priority support",
  • "UploadKbps": 50000,
  • "DownloadKbps": 100000,
  • "ConcurrentDevices": 5
}

Response samples

Content type
application/json
Example
{
  • "message": "Updated ServicePlanName to Premium Internet Plan. Updated UploadKbps to 50000. Updated DownloadKbps to 100000. Updated ConcurrentDevices to 5.",
  • "ServicePlanID": "OP001._V3SERVICEPLAN_.PREMIUM",
  • "statusCode": 200,
  • "errorProcessing": false
}

/networkoperatorconsole/equipment/configureNetworkOperator

Network operator infrastructure and settings configuration endpoint for comprehensive operator-level management.

Required Parameters:

  • AccessToken - Cognito domain administrator privileges

Network Infrastructure Configuration:

  • VLAN Ranges - MinimumAutoGeneratedVLAN/MaximumAutoGeneratedVLAN (1-4095) for GlobalWirelessPlusLocalWiredAccess, LocalWirelessAccess, GlobalWirelessRoaming
  • GlobalSSID - Array for network-wide SSIDs
  • CustomPSK - Boolean for pre-shared key functionality
  • allowOverlappingSubscriptionWiredUnit - Boolean for wired unit subscription management

Operator Profile Updates:

  • NetworkOperatorName - Branding display name
  • Address/AddressLine1/AddressLine2 - Max 500 characters each
  • PostalCode - Postal/ZIP code
  • Country.ISO3166A3 - Three-letter country code
  • EmailAddress - Format validated email
  • PhoneNumber.E164 - International phone format
  • DisplayOptionID - UI branding configuration

Terms & Conditions Configuration:

  • TandC Object - Multi-locale support (en-us, es-xl properties)
  • Max 1000000 characters per locale for HTML content

Security Controls:

  • SourceIPRangeWhiteList - CIDR notation comma-separated for administrative IP restrictions

Email Configuration:

  • EmailConfiguration.LogoPNGURLEmail - Logo URI
  • brandcolor - Hex format #RRGGBB
  • Locale-Specific Templates - en-us and es-xl with WelcomeEmail/PasswordResetEmail/PaymentConfirmationEmail properties

Features:

  • Comprehensive audit trail with administrator identification
  • Complete change logging for compliance and operational monitoring
Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with domain administrator privileges

NetworkOperatorName
string

Network operator name for branding and identification

Address
string <= 500 characters

Network operator business address

AddressLine1
string

Primary address line for operator location

AddressLine2
string

Secondary address line (suite, floor, etc.)

PostalCode
string

Postal code for operator location

Country.ISO3166A3
string

ISO 3166 Alpha-3 country code

EmailAddress
string <email>

Primary email address for network operator contact

PhoneNumber.E164
string^\+[1-9]\d{1,14}$

Phone number in E.164 international format

DisplayOptionID
string

Display options identifier for branding configuration

object

Terms and Conditions configuration for multiple locales

object

Network infrastructure configuration parameters

SourceIPRangeWhiteList
string

Comma-separated list of IP ranges (CIDR notation) allowed for administrative access

object

Email branding and template configuration

object

SMS template configuration for subscriber communications

object

Notification system configuration

object

Reporting and analytics configuration

object

E-commerce and shopping cart configuration

Okta_MetadataURL
string <uri>

Okta SAML metadata URL for SSO integration

Office365_MetadataURL
string <uri>

Office 365 SAML metadata URL for SSO integration

Redeploy
boolean

Force configuration redeployment and validation

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "NetworkOperatorName": "Enterprise WiFi Solutions",
  • "Address": "456 Corporate Center, Floor 5, Business District",
  • "PostalCode": "54321",
  • "Country.ISO3166A3": "USA",
  • "EmailAddress": "admin@enterprise-wifi.com",
  • "PhoneNumber.E164": "+15551234567",
  • "DisplayOptionID": "display_corporate_theme",
  • "NetworkConfiguration": {
    },
  • "SourceIPRangeWhiteList": "192.168.0.0/16,10.0.0.0/8,172.16.0.0/12",
  • "EmailConfiguration": {
    },
  • "SMSConfiguration": {
    },
  • "Notifications": {
    },
  • "Reporting": {
    },
  • "ShoppingCart": {
    },
  • "Okta_MetadataURL": "https://company.okta.com/app/exkexample/sso/saml/metadata",
  • "Office365_MetadataURL": "https://login.microsoftonline.com/tenant-id/federationmetadata/2007-06/federationmetadata.xml",
  • "Redeploy": false
}

Response samples

Content type
application/json
{
  • "message": "",
  • "errorProcessing": false,
  • "statusCode": 200
}

/networkoperatorconsole/equipment/listEmailTemplates

Email template retrieval endpoint for network operator administrators and customer support personnel to access email configuration and branding.

Required Parameters:

  • AccessToken - Cognito authentication with role-based permissions

Returns - Multi-Language Templates:

  • Welcome Emails - NewSubscriber, KnownSubscriber, GuestAccess, Administrator
  • Password Management - Reset, completion, security notifications
  • Profile Updates - Account changes and modifications
  • Payment Notifications - Success, failure, payment method updates
  • Service Changes - Plan modifications and service updates
  • Administrative Messages - System notifications and operator communications
  • Supported locales: English US, Spanish Latin America

Returns - Visual Branding Elements:

  • Operator Logos - LogoPNGURL for email headers
  • Brand Colors - Hex color specifications
  • Responsive Design - Mobile-optimized HTML with inline CSS

Returns - Dynamic Variable Substitution:

  • Operator information with real-time insertion
  • Venue details and location data
  • Subscriber personal data
  • Service information and plan details
  • Payment details and transaction information
  • Administrative content for system messages

Returns - Operator Profile:

  • NetworkOperatorID, NetworkOperatorName, OperatorID
  • Domain, EmailDomain, LogoPNGURL, URL
  • Address (AddressLine1/AddressLine2, City, StateProvinceRegion, PostalCode)
  • SupportedLocales array with available languages

Features:

  • Role-based access (administrator full access, customer support read access)
  • Authentication validation through Cognito
  • Configuration filtering excludes sensitive network/administrative data
  • Template structure organized by subscriber lifecycle events
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token for accessing email template configuration

Responses

Request samples

Content type
application/json

Standard request for email template configuration access

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ik5ldHdvcmsgT3BlcmF0b3IiLCJpYXQiOjE1MTYyMzkwMjJ9..."
}

Response samples

Content type
application/json

Successful retrieval of email templates with branding and variables

{}

/networkoperatorconsole/equipment/listSMSTemplates

SMS template and Terms & Conditions retrieval endpoint for network operator administrators and customer support personnel.

Required Parameters:

  • AccessToken - Cognito authentication with role-based permissions

Returns - SMS Template Configuration:

  • Welcome Messages - New subscribers, known subscribers, guest access, new/known administrators
  • Subscriber Event Messages - Password management (reset/security), profile updates, payment (confirmations/failures/billing), service changes, general notifications
  • Multi-Language Support - English US, Spanish Latin America
  • SMS configuration hierarchy organized by language and event type

Returns - Dynamic Variable Substitution:

  • Subscriber Variables - Personal, contact, and account information
  • Venue and Service Variables - Property, service plan, and operational details
  • Operator Branding Variables - Corporate identity and URLs
  • Payment and Billing Variables - Transaction and financial data
  • System and Template Variables - Dynamic content and formatting

Returns - Terms & Conditions:

  • Multi-Language Legal Content - en-us (US legal compliance), es-xl (Latin American legal framework)
  • Dynamic Content - Variable substitution for operator-specific legal terms
  • Version Control - Regulatory compliance tracking
  • Legal Framework - Telecommunications services, privacy policy integration, service agreements, dispute resolution provisions

Returns - Operator Information:

  • Basic operator details and contact information
  • SupportedLocales array with available languages

Features:

  • Filtered response (includes only SMSConfiguration, TandC, SupportedLocales)
  • Excludes sensitive data (network infrastructure, email templates, administrative controls, service plan configuration, PMS integration)
  • Role-based granular access control with regional geographical restrictions
  • Audit trail of template access and configuration changes
  • Compliance with telecommunications and data protection regulations
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with administrator or customer support privileges

Responses

Request samples

Content type
application/json

Standard request to retrieve SMS template configuration

{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJvcGVyYXRvcl9hZG1pbiIsImV4cCI6MTYzMjQxNjAwMCwiaWF0IjoxNjMyNDE1NDAwfQ..."
}

Response samples

Content type
application/json

Successful retrieval with SMS templates and Terms & Conditions

{
  • "errorProcessing": false,
  • "NetworkOperatorID": "op_123456789",
  • "NetworkOperatorName": "Metro WiFi Networks",
  • "Domain": "metrowifi.io",
  • "SMSConfiguration": {
    },
  • "TandC": {
    },
  • "SupportedLocales": {
    }
}

/networkoperatorconsole/venues/listVenueDetails

Retrieve comprehensive venue information including configuration, service plans, units, integrations, display options, and analytics for network operator management.

Returns - Venue Profile:

  • Basic Information - VenueID, VenueName, NAS-Identifier, externalVenueID, VenueType (WIRED+WIFI/WIRED+WIFI+SUPPORT/etc), dateAddedUTC
  • Location Details - Full address (AddressLine1/2), City, State, Country (ISO3166A3), PostalCode, TimeZone info (TZ, TimeZoneOffset)
  • Contact Information - PrimaryContactGivenName, PrimaryContactFamilyName, PrimaryContactEmailAddress, PrimaryContactPhoneNumber.E164, SupportEmailAddress, SupportPhoneNumber.E164
  • DeviceCount - Current connected devices at venue

Returns - Display Configuration:

  • DisplayOptionID - Active display theme identifier with inheritance from operator defaults
  • DisplayConfiguration.ThemeLight/ThemeDark - Complete branding configuration including Logo URLs (Desktop/Mobile Login, After Login), Color schemes (LoginBackground, Background, Primary, Secondary, PrimaryText, SecondaryText, Border, Link, Table, Banner, Navbar, Modal, InputBox colors in Hex)
  • DisplayConfiguration.MetaData - FavIconHRef, TitleTextContent, DescriptionContent for browser customization
  • DisplayConfiguration.Behavior - CancellationMethod (radio/checkbox), PrivacyPolicyURL, AllowedLocales (en-us, es-xl), ShowTour, ShowFooterOnLoginPage, S3Directory paths, S3DirectoryCustomComponents, GoogleAnalyticsID
  • DisplayConfiguration.Support - ShowSupportLinks, ExternallyManagedSupport, ExternalSupportSystemURL, ShowEquipmentStatusToVenueAdministrator, DisplaySuperAdminEmailModule, SupportEmailAddress, SupportPhoneNumber.E164
  • DisplayConfiguration.ShoppingCart - enableShoppingCart, AllowSelfCancellation, AllowSelfPaymentMethodUpdate, AllowSelfServicePlanUpdate

Returns - Shopping Cart & Stripe Integration:

  • ShoppingCart.enableShoppingCart - Shopping cart activation status
  • ShoppingCart.Currencies - Array of supported currencies (automatically determined from venue and unit countries)
  • ShoppingCart.StripePublishableKey - Stripe public API key for payment processing
  • ShoppingCart.Stripe_Secret_key - Stripe secret key (masked, first 10 characters + ****)
  • ShoppingCart.Stripe_Webhook_signingsecret - Webhook signing secret (masked, first 10 characters + ****)
  • ShoppingCart.StripeWebHookURL - Auto-generated webhook endpoint URL
  • ShoppingCart.Stripe_allowrefund - Refund permission flag
  • ShoppingCart.ShoppingCartPriceAdjustment.[Currency] - Price adjustment values per supported currency
  • ShoppingCart.hasVenueUnitShoppingCartPriceAdjustment - Indicates if individual units have price customizations
  • ShoppingCart.TrialCycleAdjustment - Trial period adjustment in hours

Returns - Subscription Configuration:

  • Email Preferences - suppressSubscriberEmails, sendSubscriptionAddedEmail, sendSubscriptionEndEmail (inherits from operator if not set)
  • SMS Preferences - suppressSubscriberSMS (inherits from operator if not set)
  • Reporting Settings - ReportingSubscriptionEnd_lookahead_hours, ReportingSubscriptionEnd_frequency_hours
  • WelcomeEmail_countdown_hours - Welcome email timing configuration
  • Service Plan Defaults - DefaultServicePlanID_GlobalWirelessPlusLocalWiredAccess, DefaultServicePlanID_LocalWirelessAccess, DefaultServicePlanID_Roaming (must reference globally available service plans)
  • Subscription Durations - DefaultSubscriptionDurationHours_GlobalWirelessPlusLocalWiredAccess, DefaultSubscriptionDurationHours_LocalWirelessAccess
  • allowOverlappingSubscriptionWiredUnit - Policy for multiple simultaneous subscriptions on wired units

Returns - VLAN Configuration:

  • GlobalWirelessPlusLocalWiredAccess - MinimumAutoGeneratedVLAN, MaximumAutoGeneratedVLAN (default: 1050-4095)
  • LocalWirelessAccess - MinimumAutoGeneratedVLAN, MaximumAutoGeneratedVLAN (default: 1050-4095)
  • GlobalWirelessRoaming - MinimumAutoGeneratedVLAN, MaximumAutoGeneratedVLAN (default: 1050-4095)
  • WirelessOnlyPlanVLANOffset - VLAN offset for service plans with WirelessOnlyPlan set to true (applies to wireless-only access restrictions)

Returns - External Integrations (Full Access):

  • RealPage PMS - RealPageURL, RealPageAPIKey, RealPagePMCId, RealPageSiteId, enableRealPageSync, PMS.SyncDateTimeUTC.ISO8601
  • Integrations.Ruckus - URL, TenantID, APIClientID, APIClientSecret (first 3 chars + ****), DPSKPoolID, enableSync
  • Integrations.ConnectWise - URL, Authorization (full), ConnectWiseserviceboardid, ConnectWiseClientID, ConnectWiseCompanyID
  • Integrations.PRTG - URL, PRTGUsername (PRTGPasswordHash excluded)

Returns - FCC Compliance:

  • FCCLabel.displayLabel - Boolean flag to display FCC broadband consumer disclosure label
  • FCCLabel.TypicalLatency - Typical network latency in milliseconds (-1 if not configured)

Returns - Administrative Staff:

  • VenueAdministrators - Array of venue administrator email addresses with venue-level access
  • LeasingAgents - Array of leasing agent email addresses with resident management access

Additional Returns: Property management group details, network operator connections, WiFi keypools with SSIDs and authentication mechanisms, core equipment status with real-time monitoring, available service plans with pricing, unit organization by building/floor, active subscription details, guest network configurations, and comprehensive utilization metrics.

Access Control: Network operator authentication with full access to sensitive integration credentials including complete Stripe keys, ConnectWise authorization, and unmasked API credentials.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with venue information access privileges

VenueID
required
string

Venue identifier for detailed information retrieval

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_MNO345"
}

Response samples

Content type
application/json
{
  • "VenueID": "venue_MNO345",
  • "VenueName": "Downtown Business Center",
  • "AddressLine1": "123 Business Plaza",
  • "AddressLine2": "Suite 100",
  • "City": "Metropolitan City",
  • "State": "CA",
  • "PostalCode": "90210",
  • "Country.ISO3166A3": "USA",
  • "ServicePlanConfiguration": {
    },
  • "Units": [
    ],
  • "UnitCount": 50,
  • "Keypools": {
    },
  • "NetworkOperatorConnections": {
    },
  • "analytics": {
    },
  • "DisplayConfiguration": {
    }
}

/networkoperatorconsole/venues/listVenueLog

Venue activity log and audit trail retrieval endpoint for network operators to access detailed venue operations, administrative actions, system events, and subscriber activities.

Required Parameters:

  • AccessToken - Cognito network operator authentication with venue access privileges
  • VenueID - Identifies the venue for log retrieval

Optional Parameters:

  • MinViewWindowDateUTC.ISO8601 - Start date for log entries (15-day default window)
  • MaxViewWindowDateUTC.ISO8601 - End date for log entries
  • Administrator - Email filter for specific user activities

Returns - Log Entries:

  • dateAddedUTC.ISO8601 - Timestamps with millisecond accuracy
  • function_name - API endpoints that generated events
  • Event Descriptions - Detailed activity information
  • Administrator Object - Email, given_name, family_name from Cognito
  • SourceIP - IP addresses of requests
  • SourceLocale - User locale settings
  • SourceUA - Browser and OS details
  • VenueID - Venue identifier
  • Up to 1000 entries per request with limit warning

Log Categories:

  • Configuration Changes - Venue settings, service plans, network config
  • Administrative Actions - User management, access control, policy modifications
  • System Events - Authentication attempts, service activations, equipment status
  • Subscriber Activities - Account creation, password resets, subscription changes, support interactions
  • Integration Events - External API calls, payment processing, PMS synchronizations

Processing:

  • Access validation verifies permissions
  • Date range processing applies default or custom filters
  • Log query retrieves venue-specific entries with role-based filtering
  • Administrator resolution enriches entries with Cognito user information
  • Response formation returns chronologically ordered activity log

Features:

  • Role-based access (Network Software Provider full access, Domain Administrator complete logs, Venue Administrator filtered logs excluding sensitive operations)
  • Complete operational audit trail for regulatory and compliance requirements
  • Privacy protection for administrator and operational information
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with venue access privileges

VenueID
required
string

Unique venue identifier for activity log retrieval

MinViewWindowDateUTC.ISO8601
string <date-time>

Optional start date for log retrieval window

MaxViewWindowDateUTC.ISO8601
string <date-time>

Optional end date for log retrieval window

Administrator
string

Optional administrator email filter for specific user activities

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "USA.FL.33126.XPERITY.MIAMI._V3VENUE_.USA.FL.33126.DEMO.MIAMI",
  • "MinViewWindowDateUTC.ISO8601": "2025-09-01T00:00:00.000Z",
  • "MaxViewWindowDateUTC.ISO8601": "2025-09-12T23:59:59.999Z",
  • "Administrator": "admin@example.com"
}

Response samples

Content type
application/json
{
  • "log": [
    ],
  • "LogCount": 45,
  • "message": "45 venue activity log entries retrieved",
  • "errorProcessing": false
}

/networkoperatorconsole/venues/listVenueUnitDetails

Venue unit details retrieval endpoint for network operators to access individual unit information with service plans, subscriptions, and authentication options.

Required Parameters:

  • AccessToken - Cognito network operator authentication with venue access privileges
  • VenueID - Identifies the venue for unit retrieval

Optional Parameters:

  • UnitID_internal - Specific unit identifier
  • UnitBuilding/UnitFloor/UnitID - Unit selection criteria
  • UserTimeZone - Offset in minutes for date conversions

Returns - VenueUnits Array:

  • Unit Identification - UnitID_internal, UnitID, UnitBuilding, UnitFloor
  • Address - AddressLine1, City, State, PostalCode
  • Venue Object - VenueID, VenueName, TimeZone offset
  • Keypools - SSID, Scope (global/venue/unit), DisplayOrder, currentKeypoolStatus

Returns - AvailableServicePlans Object:

  • ServicePlanName, ServicePlanDescription
  • DownloadKbps, UploadKbps bandwidth specifications
  • BillingCycleHours and pricing information
  • Concurrent device limits and trial options

Returns - Subscription Information:

  • Active Subscriptions - Service plan assignments and billing status
  • Guest Subscriptions - Temporary access details
  • Policy Timeline - Start/end dates and renewal schedules with timezone adjustments
  • Service History - Tracking of subscription changes

Processing:

  • Unit discovery locates units based on filters or retrieves all venue units
  • Service plan resolution gathers available plans and pricing
  • Keypool integration retrieves authentication configurations
  • Subscription analysis examines active/guest subscriptions and policy assignments
  • Data compilation combines all information

Features:

  • Multi-unit support (single unit queries or comprehensive inventories)
  • Timezone awareness for automatic conversion of subscription dates and policy timelines
  • Service integration with external property management and billing platforms
  • Real-time current subscription status and service availability information
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Network operator authentication token with venue access privileges

VenueID
required
string

Unique venue identifier for unit information retrieval

UnitID_internal
string

Optional specific unit identifier for single unit details

UnitBuilding
string

Optional building filter for unit selection

UnitFloor
string

Optional floor filter for unit selection

UnitID
string

Optional unit number filter for unit selection

UserTimeZone
integer

Optional timezone offset in minutes for date conversions

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "USA.FL.33126.XPERITY.MIAMI._V3VENUE_.USA.FL.33126.DEMO.MIAMI",
  • "UnitID_internal": "USA.FL.33126.XPERITY.MIAMI._V3VENUE_.USA.FL.33126.DEMO.MIAMI.101.1.A",
  • "UnitBuilding": "101",
  • "UnitFloor": "1",
  • "UnitID": "A",
  • "UserTimeZone": -300
}

Response samples

Content type
application/json
{
  • "VenueUnits": [
    ],
  • "message": "Found 5 units. Venue Details and subscriptions displayed for first unit only.",
  • "errorProcessing": false
}

/networkoperatorconsole/venues/listVenueUnitLog

Venue unit activity log and audit trail retrieval endpoint for network operators to access unit-specific logging with subscriber activities, configuration changes, and operational events.

Required Parameters:

  • AccessToken - Cognito authentication
  • VenueID - Identifies the venue
  • UnitID_internal - Identifies the specific unit

Optional Parameters:

  • MinViewWindowDateUTC.ISO8601 - Start date for log entries (15-day default window backwards from current date)
  • MaxViewWindowDateUTC.ISO8601 - End date for log entries

Log Entry Categories:

  • Subscriber Activities - Account management, authentication, service usage
  • Configuration Changes - Unit settings, service plan modifications, network policies
  • Connection Events - Device connections, session management, bandwidth monitoring
  • Administrative Actions - Support activities, manual interventions, system maintenance
  • Payment Events - Billing transactions, subscription changes, payment processing

Processing:

  • Access token validation through Cognito
  • Role authorization (Network Software Provider, Domain Administrator, Venue Administrator, Leasing Agent)
  • Unit validation verifies VenueID and UnitID_internal parameters
  • Date range processing applies custom or default filters
  • Log query retrieves unit-specific entries with role-based filtering
  • Administrator resolution enriches entries with Cognito user information
  • Response formation returns chronologically ordered log (maximum 1000 entries)

Returns:

  • Message with warning if count exceeds 1000
  • Log array with detailed event information
  • SupportedLocales object

Features:

  • Access control (Network Software Provider full access, Domain Administrator complete network access, Venue Administrator/Leasing Agent limited access excluding network equipment configurator events)
  • Automatic filtering by operator ownership and venue access permissions
  • System event management filters internal events for venue-level administrators
  • Privacy compliance for secure subscriber and operational information handling
  • Complete audit trail integrity for regulatory compliance
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid JWT access token with venue unit access permissions

VenueID
required
string

Venue identifier for unit location and access validation

UnitID_internal
required
string

Internal unit identifier for log retrieval

MinViewWindowDateUTC.ISO8601
string <date-time>

Optional start date for log window (defaults to 15 days ago)

MaxViewWindowDateUTC.ISO8601
string <date-time>

Optional end date for log window (defaults to current date)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_downtown_complex",
  • "UnitID_internal": "unit_apt_101",
  • "MinViewWindowDateUTC.ISO8601": "2025-09-01T00:00:00.000Z",
  • "MaxViewWindowDateUTC.ISO8601": "2025-09-12T23:59:59.999Z"
}

Response samples

Content type
application/json
Example
{
  • "message": "",
  • "log": [ ],
  • "SupportedLocales": {
    }
}

/networkoperatorconsole/venues/listVenueUnitUsageData

Unit-level bandwidth and data usage analytics endpoint for network operators to retrieve detailed statistics for individual venue units.

Required Parameters:

  • AccessToken - Cognito network operator authentication
  • VenueID - Internal identifier with ._V3VENUE pattern

Optional Parameters:

  • externalVenueID - Cross-reference identifier
  • UnitID_internal - Specific unit analysis (._V3VENUE pattern)
  • externalVenueUnitID - Property management integration identifier
  • UsageReportStartDateUTC.ISO8601 - Custom reporting period start date

Returns - UnitUsageData Array:

  • date - Date of usage data
  • dailyDownload - Download bytes
  • dailyUpload - Upload bytes
  • totalDaily - Total bytes
  • unitId - Internal identifier
  • externalUnitId - External reference

Processing:

  • Validate venue and unit access permissions
  • Calculate timezone-adjusted reporting periods based on venue location
  • Retrieve cached daily usage summaries from Redis
  • Apply intelligent fallback with hour-based lookback for missing data
  • Format comprehensive usage analytics

Features:

  • Daily usage reports with individual unit bandwidth consumption
  • Historical analysis up to 180 days lookback
  • Redis cache optimization for performance
  • Timezone awareness with automatic adjustment
  • Custom date ranges with flexible start date selection
  • Automated fallback for intelligent data retrieval
  • Real-time updates for current day usage statistics
  • Unit identification supporting both external and internal IDs
  • Time-series data with daily aggregated usage patterns
  • Performance tracking for unit-specific network utilization
  • Trend analysis for historical consumption patterns
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator authentication token

VenueID
required
string.*\._V3VENUE$

Internal venue identifier for usage analysis

externalVenueID
string

External venue identifier for cross-reference

UnitID_internal
string.*\._V3VENUE$

Internal unit identifier for specific unit analysis

externalVenueUnitID
string

External unit identifier for property management integration

UsageReportStartDateUTC.ISO8601
string <date-time>

Custom start date for usage reporting period (UTC)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345._V3VENUE",
  • "externalVenueID": "PROP-001-BLDG-A",
  • "UnitID_internal": "unit_67890._V3VENUE",
  • "externalVenueUnitID": "UNIT-101",
  • "UsageReportStartDateUTC.ISO8601": "2024-01-15T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "errorProcessing": false,
  • "message": "",
  • "UnitUsageData": [
    ]
}

/networkoperatorconsole/venues/listVenueUsageData

Venue-level bandwidth and data usage analytics endpoint for network operators to retrieve aggregated statistics across all venue units.

Required Parameters:

  • AccessToken - Cognito network operator authentication
  • VenueID - Internal identifier with ._V3VENUE pattern

Optional Parameters:

  • externalVenueID - Property management integration identifier
  • UsageReportStartDateUTC.ISO8601 - Custom reporting period start date

Returns - VenueUsageReport Object:

  • venueId - Venue identifier
  • reportDate - Date of report
  • totalDownload - Total download bytes
  • totalUpload - Total upload bytes
  • totalUsage - Combined total bytes
  • activeUnits - Count of active units
  • timezone - Venue timezone identifier

Processing:

  • Validate venue access and permissions
  • Calculate timezone-adjusted reporting windows based on venue country/state
  • Retrieve cached daily venue usage summaries from Redis
  • Apply date range filters and aggregations
  • Return formatted venue-level analytics

Features:

  • Aggregate venue reports combining usage data across all venue units
  • Timezone optimization with automatic adjustment
  • Redis cache performance for high-speed data retrieval (optimized for large venues)
  • Flexible date ranges with custom reporting periods and intelligent defaults
  • Daily usage summaries with complete venue bandwidth consumption
  • Historical tracking for comprehensive usage trend analysis
  • Performance metrics for venue-wide network utilization statistics
  • Data aggregation with automatic rollup from individual unit data
  • External ID support for property management system integration
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator authentication token

VenueID
required
string.*\._V3VENUE$

Internal venue identifier for usage analytics

externalVenueID
string

External venue identifier for property management integration

UsageReportStartDateUTC.ISO8601
string <date-time>

Custom start date for usage reporting period (UTC)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345._V3VENUE",
  • "externalVenueID": "PROP-001-VENUE-A",
  • "UsageReportStartDateUTC.ISO8601": "2024-01-15T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "errorProcessing": false,
  • "message": "",
  • "VenueUsageReport": {
    }
}

/networkoperatorconsole/shoppingcart/approveSubscriptionSetup

Subscription Setup Approval Workflow

Approve pending subscription setups for network operator managed services with comprehensive manual review and automated provisioning capabilities.

🔍 Approval Process

  • Manual Review: Human verification of subscription details and customer information
  • Policy Compliance: Automated verification of business rules and service policies
  • Payment Authorization: Financial verification and payment method validation
  • Service Activation: Trigger technical service provisioning and account setup

📋 Approval Criteria

  • Identity Verification: Comprehensive subscriber identification confirmation
  • Service Availability: Real-time technical capacity and resource verification
  • Financial Approval: Payment method setup and creditworthiness assessment
  • Legal Compliance: Terms acceptance and regulatory requirement validation

⚙️ Processing Features

  • Delayed Billing Support: Handle subscriptions with deferred payment setup
  • Multi-Criteria Filtering: Search pending approvals by various identifiers
  • Automated Provisioning: Trigger complete subscription setup upon approval
  • Audit Trail: Complete tracking of approval decisions and processing

🎯 Operational Controls

  • Flexible Identification: Support for internal and external ID systems

  • Batch Processing: Handle multiple subscription approvals efficiently

  • Status Management: Track approval workflow states and transitions

  • Integration Support: Seamless property management and CRM integration

  • Process Flow:

  1. Query pending subscription requests with delayed billing status
  2. Apply multi-criteria filters for targeted approval processing
  3. Perform comprehensive validation and compliance checks
  4. Execute subscription setup and service provisioning
  5. Generate authentication credentials and welcome communications
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Valid network operator administrative authentication token

VenueID
string.*\._V3VENUE$

Internal venue identifier for venue-specific approvals

UnitID_internal
string.*\._V3VENUE$

Internal unit identifier for unit-specific subscription approvals

externalVenueUnitID
string

External unit identifier for property management integration

SubscriberToken
string

Unique subscriber identification token for approval lookup

externalSubscriberID
string

External subscriber identifier for CRM system integration

externalSubscriptionID
string

External subscription identifier for billing system integration

EmailAddress
string <email>

Customer email address for subscription lookup and approval

SetupIntentId
string

Specific setup intent identifier for targeted approval

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "VenueID": "venue_12345._V3VENUE",
  • "UnitID_internal": "unit_67890._V3VENUE",
  • "externalVenueUnitID": "UNIT-101",
  • "SubscriberToken": "sub_token_abc123xyz",
  • "externalSubscriberID": "CRM-CUST-001",
  • "externalSubscriptionID": "BILLING-SUB-001",
  • "EmailAddress": "customer@example.com",
  • "SetupIntentId": "seti_1KJ123ABC_xyz789"
}

Response samples

Content type
application/json
{
  • "errorProcessing": false,
  • "message": "Subscription setup approved successfully",
  • "psk": "wifi_key_approved_xyz789",
  • "approvedSubscriptions": [
    ],
  • "approvalCount": 1
}

/networkoperatorconsole/shoppingcart/getNewSMSOTP

SMS One-Time Password Generation

Generate and send new SMS-based one-time passwords for phone number verification during shopping cart subscription processes with Stripe payment integration.

🔐 Security Features

  • Time-Limited Codes: SMS OTP with automatic expiration for security
  • Payment Intent Validation: Integration with Stripe setup intents and client secrets
  • Phone Number Verification: E.164 format validation and verification workflows
  • Duplicate Prevention: Smart checking for existing valid OTP codes

📱 SMS Integration

  • E.164 Format Support: International phone number standard compliance
  • Carrier Compatibility: Support for major mobile carriers and networks
  • Delivery Tracking: Generation timestamp tracking and validation
  • Rate Limiting: Built-in protection against OTP abuse and spam

💳 Payment Integration

  • Stripe Setup Intents: Integration with payment method setup workflows

  • Client Secret Validation: Secure payment intent verification

  • Zero-Amount Processing: Support for free trial and setup-only flows

  • Multi-Identifier Support: Flexible lookup by setup intent or client secret

  • Process Flow:

  1. Validate phone number format and payment intent credentials
  2. Locate existing payment intent with phone number association
  3. Generate new SMS OTP code with timestamp tracking
  4. Send SMS to verified E.164 formatted phone number
  5. Update payment intent record with OTP generation details
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
One of
PhoneNumber.E164
required
string^\+[1-9]\d{1,14}$

Phone number in E.164 international format for SMS delivery

StripeClientSecret
required
string

Stripe payment intent client secret for payment association

SetupIntentId
string

Internal setup intent identifier for OTP association

Responses

Request samples

Content type
application/json
{
  • "PhoneNumber.E164": "+12125551234",
  • "StripeClientSecret": "pi_3KJ123ABC_secret_xyz789",
  • "SetupIntentId": "seti_12345._V3PAYMENT"
}

Response samples

Content type
application/json
{
  • "errorProcessing": false,
  • "message": "SMS OTP sent successfully",
  • "otpSent": true,
  • "phoneNumber": "+12125551234",
  • "otpGenerationTime": "2024-12-28T20:15:30.123Z",
  • "setupIntentId": "seti_12345._V3PAYMENT"
}

/networkoperatorconsole/shoppingcart/stripepayment

Handle incoming Stripe payment webhook events for automated payment processing and subscription management integration.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
id
string

Unique event identifier from Stripe

object
string
Value: "event"

Object type, always 'event'

api_version
string

Stripe API version used for the event

created
integer

Unix timestamp when the event was created

object

Event data object

livemode
boolean

Whether the event occurred in live mode

pending_webhooks
integer

Number of pending webhook deliveries

object

Request information

type
string
Enum: "payment_intent.succeeded" "setup_intent.succeeded" "charge.refunded"

Event type

Responses

Request samples

Content type
application/json
{
  • "id": "evt_1234567890abcdef",
  • "object": "event",
  • "api_version": "2020-08-27",
  • "created": 1640995200,
  • "data": {
    },
  • "livemode": false,
  • "pending_webhooks": 1,
  • "request": {
    },
  • "type": "payment_intent.succeeded"
}

Response samples

Content type
application/json
{
  • "received": true
}

/networkoperatorconsole/shoppingcart/verifyPhoneNumber

Verify phone number ownership using SMS-delivered one-time password for secure subscription authentication.

Authorizations:
CognitoAuthorizer
Request Body schema: application/json
required
One of
PhoneNumber.E164
required
string^\+[1-9]\d{1,14}$

Phone number in E.164 international format

SMSOTP
required
string^\d{4,6}$

SMS one-time password code received by the subscriber

StripeClientSecret
required
string

Stripe client secret from payment intent or setup intent (required if SetupIntentId not provided)

SetupIntentId
string

Stripe setup intent ID (required if StripeClientSecret not provided)

Responses

Request samples

Content type
application/json
{
  • "PhoneNumber.E164": "+15551234567",
  • "SMSOTP": "123456",
  • "StripeClientSecret": "pi_1234567890abcdef_secret_xyz",
  • "SetupIntentId": "seti_1234567890abcdef"
}

Response samples

Content type
application/json
Example
{
  • "message": "Registration successful.",
  • "psk": "wifi-key-abc123def456"
}

/operatorconsole/config/listDisplayOptions

🎨 Fetch UI Display Configuration Settings

Retrieves display options for operator or venue interfaces, enabling dynamic UI configuration and branding. This endpoint supports access-based filtering with granular permission controls.

🔐 Access Control Tiers

  • NetworkSoftwareProvider: Full access to all display options
  • NetworkOperator: Access to operator-specific display configurations
  • Public: Limited access requiring specific DisplayOptionID parameter

📋 Feature Capabilities

  • Display Theme Management: Color schemes and visual presentation parameters
  • Branding Configuration: Logo placement, sizing, and visibility settings
  • Interface Layout Controls: Panel arrangement and component visibility
  • Localization Settings: Language preferences and regional format options
  • Filter Functionality: Search by DisplayOptionName or DisplayOptionID

🔄 Optimized Retrieval

  • Fast caching using display option sets
  • Efficient access with appropriate context keys

🌐 Multi-Tenant Support

  • Operator-specific display configurations
  • Role-based access control for settings visibility
  • Support for multiple locales including English and Spanish
Authorizations:
CognitoAuthNone
Request Body schema: application/json
required
AccessToken
string

Authentication token for the current session (required if DisplayOptionID not provided)

DisplayOptionID
string

ID to filter for a specific display option (required if AccessToken not provided)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "string",
  • "DisplayOptionID": "string"
}

Response samples

Content type
application/json
{
  • "DisplayOptions": [
    ],
  • "SupportedLocales": { },
  • "message": "string",
  • "errorProcessing": false
}

Generate Cambium Networks ePSK Authentication Packets

🔑 Cambium ePSK EAPOL Packet Generator

Generates WPA2-PSK EAPOL authentication packets optimized for Cambium Networks access points and controllers with ePSK (Enhanced Pre-Shared Key) support.

🎯 Purpose

Development and testing tool for network operators to:

  • Generate valid EAPOL authentication frames for Cambium ePSK deployments
  • Test subscriber authentication flows before production deployment
  • Validate PSK derivation and packet structure for Cambium equipment
  • Debug authentication issues with Cambium-specific packet formatting

📡 Technical Specifications

  • Protocol: IEEE 802.11i (WPA2-PSK)
  • Key Derivation: PBKDF2-HMAC-SHA1 (4096 iterations)
  • MIC Algorithm: HMAC-SHA1 (16-byte truncation)
  • Vendor: Cambium Networks (ePSK-optimized formatting)
  • Output: Complete EAPOL Key frame with Message 2/4 structure

🔐 Authentication Flow

  1. PMK derived from PSK using PBKDF2
  2. PTK generated using 4-way handshake parameters
  3. MIC calculated over EAPOL frame (zeroed MIC field)
  4. Complete Message 2 packet returned with all fields

📋 Required Parameters

  • AccessToken: Valid JWT for network operator authentication
  • NAS-Identifier: Network Access Server identifier (typically venue or AP name)
  • SSID: Network SSID for PMK derivation
  • PSK: Pre-shared key (plain text, minimum 8 characters)

📤 Generated Output

Returns complete EAPOL packet structure:

  • ANonce: Authenticator nonce (32 bytes, hex)
  • SNonce: Supplicant nonce (32 bytes, hex)
  • BSSID: Access point MAC address (6 bytes, hex with colons)
  • MACAddress: Client MAC address (6 bytes, hex with colons)
  • EAPOLFrame: Complete EAPOL Key frame (hex string)
  • PMK: Pairwise Master Key (64 hex characters)

⚠️ Security Notice

This is a testing tool for authorized network operators only. Generated packets contain cryptographic material and should be handled securely. Never expose PSK values in logs or unsecured channels.

🏢 Use Cases

  • Pre-deployment validation of Cambium ePSK configurations
  • Troubleshooting authentication failures in test environments
  • Integration testing with RADIUS servers and authentication systems
  • Network equipment validation and performance testing
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token for network operator console access

NAS-Identifier
required
string

Network Access Server identifier (venue name or AP identifier)

SSID
required
string

WiFi network SSID for PMK derivation

PSK
required
string [ 8 .. 63 ] characters

Pre-shared key (plain text, 8-63 characters)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "NAS-Identifier": "luxury-apartments-bldg1",
  • "SSID": "Resident_WiFi",
  • "PSK": "SecurePassword123"
}

Response samples

Content type
application/json
{
  • "ANonce": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
  • "SNonce": "fedcba9876543210fedcba98765432100123456789abcdef0123456789abcdef",
  • "BSSID": "00:11:22:33:44:55",
  • "MACAddress": "AA:BB:CC:DD:EE:FF",
  • "EAPOLFrame": "0103007502010a0000000000000000...",
  • "PMK": "92d95bbacec86e5926884d8b0c9d8c9e4009706644f58e63b18fd419c6e3c6cb",
  • "message": "Cambium ePSK packet generated successfully",
  • "errorProcessing": false
}

Generate Ruckus DPSK Attribute 153 Values

🔑 Ruckus DPSK Attribute 153 Generator

Generates Ruckus Wireless specific DPSK (Dynamic PSK) values formatted as RADIUS Attribute 153 for WPA3-Personal and WPA2-PSK authentication.

🎯 Purpose

Development and testing tool for network operators to:

  • Generate valid Ruckus Attribute 153 values for DPSK provisioning
  • Test WPA3-DPSK authentication flows with Ruckus controllers
  • Validate DPSK format and structure for Ruckus deployments
  • Debug DPSK provisioning issues with R1 and ZoneDirector controllers

📡 Technical Specifications

  • Vendor: Ruckus Wireless (R1 Controller, ZoneDirector, SmartZone)
  • Attribute: RADIUS Vendor-Specific Attribute 153
  • Authentication: WPA3-DPSK (preferred) or WPA2-PSK
  • Format: Passphrase-based or PMK-based DPSK
  • Integration: Direct controller API or RADIUS proxy

🔐 DPSK Structure

Ruckus Attribute 153 format:

Attribute: 153 (DPSK)
Value: <passphrase> or <PMK-hex>
Format: ASCII (passphrase) or Hex (PMK)

📋 Required Parameters

  • AccessToken: Valid JWT for network operator authentication
  • SSID: Target network SSID for DPSK assignment
  • Passphrase (optional): Human-readable passphrase (8-63 chars)
  • PMK (optional): Pre-computed PMK in hex format (64 chars)
  • VenueID: Venue identifier for DPSK scope

📤 Generated Output

Returns Ruckus-formatted DPSK values:

  • Attribute153: Complete RADIUS attribute value
  • DPSKPassphrase: User-friendly passphrase (if generated)
  • PMK: Pairwise Master Key (hex format)
  • ExpirationDate: Optional DPSK expiration timestamp

⚠️ Security Notice

DPSK values provide network access and should be:

  • Stored securely with encryption
  • Transmitted only over secure channels
  • Rotated regularly per security policy
  • Associated with specific subscribers for auditing

🏢 Use Cases

  • WPA3-DPSK provisioning for Ruckus R1 controllers
  • Testing DPSK authentication before subscriber activation
  • Integration testing with RADIUS servers
  • Debugging Ruckus controller DPSK issues
  • Bulk DPSK generation for venue deployments
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token for network operator console access

SSID
required
string

Target WiFi network SSID

VenueID
required
string

Venue identifier for DPSK scope

Passphrase
string [ 8 .. 63 ] characters

Custom passphrase (8-63 characters, optional - auto-generated if omitted)

PMK
string^[0-9a-fA-F]{64}$

Pre-computed PMK in hex (64 characters, optional)

ExpirationDays
integer [ 0 .. 365 ]

Number of days until DPSK expires (optional, 0 = never)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "SSID": "Resident_Secure",
  • "VenueID": "venue_12345",
  • "Passphrase": "MySecurePass2024",
  • "PMK": "92d95bbacec86e5926884d8b0c9d8c9e4009706644f58e63b18fd419c6e3c6cb",
  • "ExpirationDays": 90
}

Response samples

Content type
application/json
{
  • "Attribute153": "MySecurePass2024",
  • "DPSKPassphrase": "MySecurePass2024",
  • "PMK": "92d95bbacec86e5926884d8b0c9d8c9e4009706644f58e63b18fd419c6e3c6cb",
  • "ExpirationDate": "2024-04-17T00:00:00.000Z",
  • "SSID": "Resident_Secure",
  • "VenueID": "venue_12345",
  • "message": "Ruckus DPSK Attribute 153 generated successfully",
  • "errorProcessing": false
}

Generate Standard WPA2-PSK EAPOL Authentication Packets

🔑 Standard WPA2-PSK EAPOL Packet Generator

Generates IEEE 802.11i compliant WPA2-PSK EAPOL authentication packets for testing and validation across multiple vendor equipment platforms.

🎯 Purpose

Universal development and testing tool for network operators to:

  • Generate standard WPA2-PSK EAPOL authentication frames
  • Test authentication flows across multi-vendor deployments
  • Validate PMK and PTK derivation for WPA2 compliance
  • Debug authentication issues with vendor-agnostic packet format
  • Integration testing with RADIUS servers and authentication systems

📡 Technical Specifications

  • Protocol: IEEE 802.11i-2004 (WPA2-PSK)
  • Key Derivation: PBKDF2-HMAC-SHA1 (PMK, 4096 iterations)
  • PTK Generation: SHA1-based PRF for PTK derivation
  • MIC Algorithm: HMAC-SHA1 with 16-byte truncation
  • Vendor Compatibility: Universal (MikroTik, Ubiquiti, Cisco, etc.)
  • Output Format: Complete EAPOL Key frame (Message 2 of 4-way handshake)

🔐 Authentication Flow

WPA2-PSK 4-way handshake packet structure:

  1. PMK Derivation: PBKDF2(PSK, SSID, 4096) → 32-byte PMK
  2. PTK Generation: PRF(PMK, "Pairwise key expansion", nonces + MAC addresses) → 48-byte PTK
  3. KCK Extraction: First 16 bytes of PTK (Key Confirmation Key)
  4. MIC Calculation: HMAC-SHA1(KCK, EAPOL frame with zeroed MIC) → 16-byte MIC
  5. Packet Assembly: Complete EAPOL frame with MIC inserted

📋 Required Parameters

  • AccessToken: Valid JWT for network operator authentication
  • NAS-Identifier: Network Access Server identifier (AP name or venue identifier)
  • SSID: Network SSID used for PMK derivation
  • PSK: Pre-shared key (8-63 ASCII characters or 64 hex digits)

📤 Generated Output

Returns complete EAPOL packet structure:

  • EAPOLFrame: Full EAPOL Key frame (hex string, ~250 bytes)
  • ANonce: Authenticator nonce (32 bytes, 64 hex characters)
  • SNonce: Supplicant nonce (32 bytes, 64 hex characters)
  • BSSID: Access point MAC address (XX:XX:XX:XX:XX:XX format)
  • MACAddress: Client station MAC address (XX:XX:XX:XX:XX:XX format)
  • PMK: Pairwise Master Key (32 bytes, 64 hex characters)
  • KeyVersion: EAPOL key descriptor version (typically 2 for WPA2)

🔍 Packet Structure Details

EAPOL Key Frame format:

Version: 0x02 (EAPOL-Key)
Type: 0x03 (Key)
Key Information: 0x010a (Pairwise, Install, ACK, MIC, Secure)
Key Length: 0 (not used in WPA2-PSK)
Replay Counter: 8 bytes (monotonically increasing)
Key Nonce: 32 bytes (ANonce from AP)
Key IV: 16 bytes (typically zeros)
Key RSC: 8 bytes (receive sequence counter)
Key MIC: 16 bytes (HMAC-SHA1 truncated)
Key Data Length: Variable (contains RSN IE)

⚠️ Security Notice

This is a testing tool for authorized network operators only:

  • Generated packets contain sensitive cryptographic material
  • PSK values must never be logged or transmitted insecurely
  • PMK exposure allows network access - handle with extreme care
  • Use only in isolated test environments or secured production systems
  • Audit all packet generation activities for compliance

🏢 Use Cases

  • Pre-deployment testing: Validate authentication before subscriber onboarding
  • Multi-vendor validation: Test compatibility across different AP manufacturers
  • RADIUS integration: Verify RADIUS server authentication responses
  • Troubleshooting: Debug authentication failures in production environments
  • Performance testing: Generate test traffic for load and stress testing
  • Security audits: Validate cryptographic implementation correctness

🌐 Vendor Compatibility

Tested and compatible with:

  • MikroTik: RouterOS WPA2-PSK authentication
  • Ubiquiti: UniFi and EdgeMAX platforms
  • Cisco: Aironet and Catalyst wireless
  • Aruba: IAP and controller-based deployments
  • Nomadix: AG series gateways
  • Any IEEE 802.11i compliant equipment
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token for network operator console access

NAS-Identifier
required
string

Network Access Server identifier (venue/AP name)

SSID
required
string <= 32 characters

WiFi network SSID for PMK derivation

PSK
required
string [ 8 .. 64 ] characters

Pre-shared key (8-63 ASCII or 64 hex characters)

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "NAS-Identifier": "downtown-apartments-ap01",
  • "SSID": "ResidentWiFi_5G",
  • "PSK": "StrongPassword2024!"
}

Response samples

Content type
application/json
{
  • "EAPOLFrame": "0203007502010a00000000000000000a1b2c3d4e5f6789012345678901234567890abcdef...",
  • "ANonce": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
  • "SNonce": "fedcba9876543210fedcba98765432100123456789abcdef0123456789abcdef",
  • "BSSID": "00:11:22:33:44:55",
  • "MACAddress": "AA:BB:CC:DD:EE:FF",
  • "PMK": "92d95bbacec86e5926884d8b0c9d8c9e4009706644f58e63b18fd419c6e3c6cb",
  • "KeyVersion": 2,
  • "message": "Standard WPA2-PSK packet generated successfully",
  • "errorProcessing": false
}

Generate FT-PSK (802.11r) Fast Transition EAPOL Packets

🚀 FT-PSK (802.11r) Fast Transition EAPOL Packet Generator

Generates IEEE 802.11r-2008 compliant FT-PSK (Fast Transition Pre-Shared Key) EAPOL authentication packets enabling seamless roaming between access points with <50ms handoff latency.

🎯 Purpose

Advanced development and testing tool for network operators deploying 802.11r:

  • Generate FT-PSK EAPOL authentication frames for fast roaming scenarios
  • Test seamless handoff between access points in enterprise deployments
  • Validate FT key hierarchy (PMK-R0, PMK-R1, PTK) derivation
  • Debug 802.11r authentication failures and roaming performance
  • Integration testing with FT-capable controllers and RADIUS servers

📡 Technical Specifications

  • Protocol: IEEE 802.11r-2008 (Fast BSS Transition)
  • AKM Suite: 00-0F-AC:4 (FT-PSK, suite selector 1027076)
  • Key Hierarchy: PMK → PMK-R0 → PMK-R1 → PTK (SHA256-based)
  • Key Derivation: SHA256-PRF per IEEE 802.11-2020 Section 12.7.1.7.2
  • MIC Algorithm: HMAC-SHA1 (16-byte truncation for compatibility)
  • Fast Transition: Over-the-air (FT-over-air) protocol support
  • Roaming Latency: Target <50ms handoff time

🔐 FT-PSK Key Hierarchy

802.11r introduces hierarchical key derivation for fast roaming:

PMK (Pairwise Master Key)
 ↓ SHA256-PRF("FT-R0", SSID || MDID || R0KH-ID || STA-MAC)
PMK-R0 (R0 Key Holder Key, 32 bytes from 48-byte output)
 ↓ SHA256-PRF("FT-R1", R1KH-ID || STA-MAC)
PMK-R1 (R1 Key Holder Key, 32 bytes)
 ↓ SHA256-PRF("FT-PTK", SNonce || ANonce || BSSID || STA-MAC)
PTK (Pairwise Transient Key, 48 bytes)
 ↓ Extract KCK
KCK (Key Confirmation Key, first 16 bytes of PTK)
 ↓ HMAC-SHA1 MIC

📋 Required Parameters

  • AccessToken: Valid JWT for network operator authentication
  • NAS-Identifier: Network Access Server identifier (becomes R0KH-ID)
  • SSID: Network SSID for PMK-R0 derivation context
  • PSK: Pre-shared key (8-63 ASCII characters or 64 hex digits)
  • BSSID (optional): Target AP MAC address (auto-generated if omitted)
  • MACAddress (optional): Client MAC address (auto-generated if omitted)

📤 Generated Output

Returns complete FT-PSK EAPOL packet structure:

  • EAPOLFrame: Full FT-PSK EAPOL Key frame (hex string, ~250 bytes)
  • ANonce: Authenticator nonce (32 bytes, 64 hex characters)
  • SNonce: Supplicant nonce (32 bytes, 64 hex characters)
  • BSSID: Target access point MAC address (XX:XX:XX:XX:XX:XX)
  • MACAddress: Client station MAC address (XX:XX:XX:XX:XX:XX)
  • PMK: Pairwise Master Key (32 bytes, 64 hex characters)
  • PMK_R0: R0 Key Holder Key (32 bytes, 64 hex characters)
  • PMK_R1: R1 Key Holder Key (32 bytes, 64 hex characters)
  • FTIE: Fast Transition Information Element (hex string)
  • MDIE: Mobility Domain Information Element (hex string)
  • R0KH_ID: R0 Key Holder identifier (ASCII, typically NAS-Identifier)
  • R1KH_ID: R1 Key Holder identifier (6-byte MAC, BSSID)

🔍 FT-PSK Packet Structure Details

EAPOL Key Frame with FT extensions:

EAPOL Header:
  Version: 0x01 (EAPOL version 1 for FT)
  Type: 0x03 (EAPOL-Key)
  Length: Variable (~250 bytes for FT-PSK)

Key Information: 0x010B
  Key Descriptor: 2 (AES-CCM)
  Key Type: Pairwise
  Install: Set
  ACK: Set  
  MIC: Set
  Secure: Set

Key Data (contains):
  - MDIE (Mobility Domain IE): Element ID 54
    * Mobility Domain ID (MDID): 2 bytes
    * FT Capability: 1 byte (0x01 = FT-over-air)
  
  - FTIE (Fast Transition IE): Element ID 55
    * MIC Control: 2 bytes (zeroed during generation)
    * MIC: 16 bytes (zeroed during MIC calculation)
    * ANonce: 32 bytes (authenticator nonce)
    * SNonce: 32 bytes (supplicant nonce)
    * Sub-elements:
      - Sub-element 1: R1KH-ID (6 bytes, BSSID)
      - Sub-element 3: R0KH-ID (variable, NAS-Identifier)

🚀 Fast Roaming Benefits

  • Seamless Handoff: <50ms transition between APs
  • Voice/Video Continuity: No dropped VoIP calls or video streams
  • Enterprise Grade: Mission-critical applications remain connected
  • Pre-authentication: PMK-R1 keys distributed to neighbor APs
  • No Full Re-auth: Eliminates full RADIUS round-trip during roaming

⚠️ Security Notice

FT-PSK packets contain sensitive cryptographic hierarchy:

  • PMK, PMK-R0, PMK-R1, and PTK provide complete network access
  • R0KH-ID and R1KH-ID reveal network topology and AP relationships
  • FTIE sub-elements expose key holder infrastructure
  • Use only in secured test environments or production with encryption
  • Audit all FT packet generation for compliance and security monitoring
  • Never log or transmit key material over unsecured channels

🏢 Use Cases

  • Enterprise Roaming: Deploy 802.11r in high-density venues (hospitals, stadiums, airports)
  • VoIP Networks: Ensure seamless handoff for wireless phone systems
  • Real-time Applications: Video conferencing, streaming, IoT devices requiring mobility
  • Multi-building Campuses: Roaming between buildings with different controllers
  • Troubleshooting: Debug FT authentication failures and roaming performance
  • Pre-deployment Testing: Validate FT-PSK before production rollout
  • Performance Validation: Measure handoff latency and key derivation correctness

🌐 Vendor Compatibility

FT-PSK (802.11r) tested with:

  • Ruckus: R1 Controller, SmartZone, ZoneDirector (802.11r support)
  • Cisco: WLC 9800 series, Catalyst 9100 APs (FT-over-air/FT-over-DS)
  • Aruba: Mobility Controllers, Instant APs (802.11k/r/v)
  • Ubiquiti: UniFi Dream Machine Pro, WiFi 6 APs (FT roaming)
  • MikroTik: RouterOS with 802.11r capability
  • Any IEEE 802.11r-2008 compliant equipment

📊 Performance Metrics

  • Key Derivation: ~2ms for full PMK → PMK-R0 → PMK-R1 → PTK hierarchy
  • Packet Generation: ~5ms including MIC calculation
  • Roaming Handoff: <50ms target (depends on AP/controller implementation)
  • Authentication Success: >99.9% in production FT deployments

🆕 New Feature (January 2026)

This endpoint was added as part of VAULT v1.1.0 to support IEEE 802.11r Fast Transition deployments across enterprise venues. Complements existing WPA2-PSK and WPA3-DPSK authentication protocols.

Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

JWT authentication token for network operator console access

NAS-Identifier
required
string

Network Access Server identifier (becomes R0KH-ID for FT)

SSID
required
string <= 32 characters

WiFi network SSID for PMK-R0 derivation

PSK
required
string [ 8 .. 64 ] characters

Pre-shared key (8-63 ASCII or 64 hex characters)

BSSID
string^([0-9A-Fa-f]{2}[:-]){5}[0-9A-Fa-f]{2}$

Target AP MAC address (optional, auto-generated if omitted)

MACAddress
string^([0-9A-Fa-f]{2}[:-]){5}[0-9A-Fa-f]{2}$

Client station MAC address (optional, auto-generated if omitted)

MDID
string^[0-9a-fA-F]{4}$

Mobility Domain ID (2-byte hex, optional, defaults to 'a1b2')

Responses

Request samples

Content type
application/json
{
  • "AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "NAS-Identifier": "luxury-apartments-controller",
  • "SSID": "Enterprise_Secure_5G",
  • "PSK": "FTRoaming2024Secure!",
  • "BSSID": "00:1A:2B:3C:4D:5E",
  • "MACAddress": "AA:BB:CC:DD:EE:FF",
  • "MDID": "a1b2"
}

Response samples

Content type
application/json
{
  • "EAPOLFrame": "0103009502010b00000000000000010a1b2c3d4e5f67890123456789012345...",
  • "ANonce": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
  • "SNonce": "fedcba9876543210fedcba98765432100123456789abcdef0123456789abcdef",
  • "BSSID": "00:1A:2B:3C:4D:5E",
  • "MACAddress": "AA:BB:CC:DD:EE:FF",
  • "PMK": "92d95bbacec86e5926884d8b0c9d8c9e4009706644f58e63b18fd419c6e3c6cb",
  • "PMK_R0": "7a3f8e1c9d2b4a5e6f0c8d9e1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
  • "PMK_R1": "3c5d7e9f1a2b4c6d8e0f1a3c5d7e9f1b3d5f7a9c1e3f5a7c9e1f3a5c7d9e1f3",
  • "FTIE": "37820000000000000000000000000000000001...",
  • "MDIE": "3603a1b201",
  • "R0KH_ID": "luxury-apartments-controller",
  • "R1KH_ID": "00:1A:2B:3C:4D:5E",
  • "MDID": "a1b2",
  • "message": "FT-PSK (802.11r) packet generated successfully with full key hierarchy",
  • "errorProcessing": false
}

Operator/Config

⚙️ Network Operator Configuration

Network operator configuration management for system administrators to manage controller profiles, integrations, and infrastructure settings.

Configuration Management

  • 📡 Controller Profiles: Ruckus R1 controller configuration for WPA3-DPSK authentication
  • 🔑 API Credentials: Secure credential management and rotation
  • 🌍 Multi-Region Support: US, EU, and Asia cloud endpoint management
  • 🔄 Synchronization Settings: Automatic DPSK provisioning and sync control
  • 📊 Integration Hub: Third-party system configuration and API management
  • 🔒 Security Controls: Access policies, encryption, and authentication settings

Administrative Tools

  • 🔧 Profile Management: Create, update, and delete controller configurations
  • 📋 Audit Logging: Configuration change tracking and compliance monitoring
  • 🏢 Venue Assignment: Controller-to-venue mapping and deployment
  • 📊 Performance Analytics: Configuration health and operational metrics

/operatorconsole/config/addRuckusR1Controller

Create new Ruckus R1 controller profile for WPA3-DPSK WiFi authentication with automatic DPSK provisioning and optional enableSync configuration.

Required Parameters:

  • AccessToken - Network operator authentication with code branch write access
  • ControllerName - Unique profile name (1-128 characters, sanitized)
  • URL - Ruckus Cloud API endpoint (must be: https://api.ruckus.cloud, https://api.eu.ruckus.cloud, or https://api.asia.ruckus.cloud)
  • APIClientID - Ruckus One API client identifier (1-128 characters)
  • APIClientSecret - Ruckus One API client secret (1-128 characters)
  • TenantID - Ruckus One tenant identifier (1-128 characters)

Optional Parameters:

  • enableSync - Enable automatic DPSK synchronization (boolean, default: true if not explicitly set to false)
  • updatePools - Fetch DPSK pools from Ruckus R1 and create keypools after controller creation (boolean, default: true)

Controller Features:

  • WPA3-DPSK authentication with per-device keys
  • Automatic DPSK ID retrieval from DPSK name via RuckusR1.mjs utility
  • Multi-region cloud controller support (US, EU, Asia)
  • Venue-level controller assignment

Validation Rules:

  • ControllerName: Max 128 chars input, sanitized to 64 characters (alphanumeric, spaces, dots, underscores, hyphens)
  • URL: Must be exactly one of three regional endpoints (no other URLs accepted)
  • APIClientID: Max 128 chars input, sanitized to 64 characters
  • APIClientSecret: Max 128 chars input, sanitized to 64 characters
  • TenantID: Max 128 chars input, sanitized to 64 characters
  • URL/APIClientID/TenantID combination must be unique within operator
  • Generated ControllerID must not already exist
  • Code branch write access verified before creation

System Effects:

  • Creates controller profile with OperatorID association
  • Generates unique ControllerID: {OperatorID}.V3RUCKUSR1CONTROLLER.{ControllerName_UPPERCASE_SPACES_TO_UNDERSCORES}
  • Automatically applies initial configuration with enableSync setting (defaults to true if not explicitly false)
  • Logs creation event with administrator attribution (SourceIP, OS, Browser, Locale)

Processing Flow:

  1. Validates code branch write access
  2. Validates all required fields (presence, length, format)
  3. Checks for duplicate URL/APIClientID/TenantID combination
  4. Generates ControllerID and validates uniqueness
  5. Creates controller profile with timestamp
  6. Logs creation event to audit system
  7. Sets enableSync to true if not explicitly set to false
  8. Automatically applies initial controller configuration
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Domain administrator access token with controller management privileges

ControllerName
required
string [ 1 .. 128 ] characters

Unique controller profile name (max 128 chars input, sanitized to 64 characters - alphanumeric, spaces, dots, underscores, hyphens only)

URL
required
string
Enum: "https://api.ruckus.cloud" "https://api.eu.ruckus.cloud" "https://api.asia.ruckus.cloud"

Ruckus Cloud API regional endpoint URL

APIClientID
required
string [ 1 .. 128 ] characters

Ruckus One API client ID from cloud portal (max 128 chars input, sanitized to 64 characters)

APIClientSecret
required
string [ 1 .. 128 ] characters

Ruckus One API client secret (max 128 chars input, sanitized to 64 characters, stored securely)

TenantID
required
string [ 1 .. 128 ] characters

Ruckus One tenant identifier from cloud portal (max 128 chars input, sanitized to 64 characters)

enableSync
boolean
Default: true

Enable automatic DPSK synchronization with Ruckus Cloud (default: true if not explicitly false)

updatePools
boolean
Default: true

Fetch DPSK pools from Ruckus R1 and create keypools after controller creation (optional, default: true)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "ControllerName": "Main Campus R1",
  • "URL": "https://api.ruckus.cloud",
  • "APIClientID": "client_abc123xyz789",
  • "APIClientSecret": "secret_def456uvw012",
  • "TenantID": "tenant_ghi789rst345",
  • "enableSync": true
}

Response samples

Content type
application/json
{
  • "message": "Ruckus R1 Controller added. ",
  • "ControllerID": "op_network_001._V3RUCKUSR1CONTROLLER_.Main_Campus_R1",
  • "ControllerName": "Main Campus R1",
  • "URL": "https://api.ruckus.cloud",
  • "enableSync": true,
  • "AvailableDPSKPools": [ ],
  • "AvailableDPSKPoolCount": 0
}

/operatorconsole/config/configureRuckusR1Controller

Update existing Ruckus R1 controller configuration including credentials, sync settings, DPSK pool synchronization, or permanently delete controller profile with cascade keypool cleanup.

Required Parameters:

  • AccessToken - Network operator authentication with code branch write access
  • ControllerID - Target controller identifier (format: {OperatorID}._V3RUCKUSR1CONTROLLER_.{CONTROLLER_NAME})

8 Configuration Operations:

  1. Update ControllerName - Rename controller (validates uniqueness, sanitized to 64 chars)
  2. Update URL - Change Ruckus Cloud regional API endpoint (US/EU/Asia)
  3. Update APIClientID - Rotate API client identifier (sanitized to 64 chars)
  4. Update APIClientSecret - Rotate API client secret (sanitized to 64 chars)
  5. Update TenantID - Change tenant identifier (sanitized to 64 chars)
  6. Toggle enableSync - Enable/disable automatic DPSK synchronization
  7. Update DPSK Pools - Fetch DPSK pools from Ruckus R1 and create keypools (updatePools parameter)
  8. Delete Controller - Remove controller after keypool cleanup and multi-region replication

DPSK Pool Synchronization (updatePools):

  • Automatic Trigger: Set to true when called from addRuckusR1Controller
  • API Call: RuckusR1.getDPSKPools(url, tenantId, clientId, clientSecret)
  • Pool Discovery: Queries WPA3 DPSK SSIDs and retrieves associated pool IDs
  • Deduplication: Filters SSIDs without dpskPoolID or dpskPoolName
  • Pool Data: Returns array of {id: dpskPoolID, name: ssidName, DPSKPoolName: poolName} objects
  • Keypool Creation: For each pool, creates keypool with SSID=pool.name, Scope=pool.id, RuckusR1ControllerID=ControllerID, RuckusR1DPSKPoolName=pool.DPSKPoolName, AuthenticationMechanism='WPA3'
  • Error Resilience: Individual keypool creation failures logged but don't stop remaining pool processing
  • Response Enhancement: AvailableDPSKPools array stored in controller vertex and included in response
  • Use Case: Synchronizes Vault keypools with Ruckus R1 DPSK pools for WPA3 authentication
  • Error Handling: Returns translated error if pool fetch fails, sets AvailableDPSKPools to []

Update Features:

  • Modify individual properties without affecting unchanged settings
  • Rotate API credentials securely with validation
  • Toggle synchronization without service disruption
  • Cache automatically invalidated on any changes
  • Audit logging for all configuration changes

Deletion Requirements:

  • Controller must not be linked to any venues
  • Validates venue associations before deletion
  • Synchronizes deletion across all regions
  • Irreversible operation - removes all configuration data

Validation Rules:

  • ControllerID must exist in the system
  • ControllerName: Validated for uniqueness if provided
  • TenantID: Validated as part of URL/APIClientID/TenantID uniqueness check if any of those three change
  • URL/APIClientID/TenantID combination uniqueness (using provided or existing values)
  • All credential fields validated for length (≤128 input), sanitized to 64 characters, and character safety
  • Code branch write access verified before updates

System Effects:

  • Updates controller properties: URL, APIClientID, APIClientSecret, enableSync (only changed fields)
  • Note: ControllerName and TenantID are validated but NOT updated
  • Sets dateModifiedUTC timestamp
  • Logs configuration changes with administrator attribution
  • On delete: Synchronizes deletion across regions

Processing Flow:

  1. Validates code branch write access
  2. Validates optional fields if provided (length, format)
  3. Verifies controller exists
  4. Checks ControllerName uniqueness if changing name
  5. Checks URL/APIClientID/TenantID combination uniqueness
  6. If delete=true: Checks venue associations, removes controller profile
  7. If updating: Applies property updates, logs changes
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Domain administrator access token with controller management privileges

ControllerID
required
string

Unique Ruckus R1 controller identifier for configuration

ControllerName
string [ 1 .. 128 ] characters

Validate controller profile name uniqueness (optional, max 128 chars input, sanitized to 64 characters, validated but NOT updated in database)

URL
string
Enum: "https://api.ruckus.cloud" "https://api.eu.ruckus.cloud" "https://api.asia.ruckus.cloud"

Updated Ruckus Cloud API endpoint (optional, must be valid endpoint)

APIClientID
string [ 1 .. 128 ] characters

Updated Ruckus One API client ID (optional, max 128 chars input, sanitized to 64 characters, validated for safe characters)

APIClientSecret
string [ 1 .. 128 ] characters

Updated Ruckus One API client secret (optional, max 128 chars input, sanitized to 64 characters, validated for safe characters)

TenantID
string [ 1 .. 128 ] characters

Validate Ruckus One tenant ID (optional, max 128 chars input, sanitized to 64 characters, validated in URL/APIClientID/TenantID uniqueness check but NOT updated in database)

enableSync
boolean

Enable/disable automatic DPSK synchronization (optional)

updatePools
boolean

Fetch DPSK pools from Ruckus R1 Cloud Controller and create keypools (optional, automatically set to true when called from addRuckusR1Controller)

delete
boolean

Flag to permanently delete controller (irreversible, requires no venue associations)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "ControllerID": "op_network_001._V3RUCKUSR1CONTROLLER_.Main_Campus_R1",
  • "enableSync": true
}

Response samples

Content type
application/json
Example
{
  • "message": "Updating enableSync to true. Configuration updated successfully.",
  • "errorProcessing": false,
  • "ControllerID": "op_network_001._V3RUCKUSR1CONTROLLER_.Main_Campus_R1"
}

/operatorconsole/config/listRuckusR1Controllers

Retrieve complete catalog of Ruckus R1 controller profiles configured for the operator with optional filtering capabilities.

Required Parameters:

  • AccessToken - Network operator authentication (domain administrator access required)

Optional Filter Parameters:

  • ControllerID - Filter by specific controller identifier
  • ControllerName - Filter by controller profile name
  • URL - Filter by Ruckus Cloud API endpoint
  • APIClientID - Filter by API client identifier
  • TenantID - Filter by tenant identifier
  • APIClientSecret - Filter by API client secret

Data Source:

  • Optimized retrieval for fast access
  • Automatically updated when controllers are added or configured

Filtering Behavior:

  • Only string fields supported (typeof value === 'string' && value.length > 0)
  • Boolean fields like enableSync cannot be filtered
  • Uses loose equality (==) for exact match comparison
  • Multiple filters combine with AND logic (progressive filtering)
  • Empty string filter values ignored (no filtering applied)

Response Data:

  • Complete controller configuration including credentials
  • Cloud endpoint URLs and regional assignments
  • Synchronization status and settings
  • Creation and modification timestamps
  • Supported cloud regions list

Use Cases:

  • Controller inventory management and auditing
  • Venue assignment planning and validation
  • Credential verification and rotation tracking
  • Multi-region deployment coordination
Authorizations:
CognitoUserPool
Request Body schema: application/json
required
AccessToken
required
string

Domain administrator access token with controller view privileges

ControllerID
string

Filter by specific controller identifier

ControllerName
string

Filter by controller profile name (exact match)

URL
string

Filter by Ruckus Cloud API endpoint URL

APIClientID
string

Filter by Ruckus One API client identifier (exact match, case-sensitive)

APIClientSecret
string

Filter by Ruckus One API client secret (exact match, case-sensitive)

TenantID
string

Filter by Ruckus One tenant identifier (exact match, case-sensitive)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
Example
{
  • "RuckusR1Controllers": [
    ],
  • "SupportedCloudRegions": []
}

/operatorconsole/config/addPMSProfile

Create new PMS (Property Management System) profile for automated venue unit and resident synchronization with RealPage or Entrata platforms. Multi-region deployment with primary region forwarding and automatic configuration.

Architecture Pattern:

  • Multi-region coordination - Local validation with synchronized execution across regions
  • Auto-configuration - Automatically applies enableSync configuration after profile creation
  • Audit logging - Records profile creation with administrator attribution

Required Parameters:

  • AccessToken - Network operator authentication with domain administrator privileges
  • ProfileName - Unique profile name (max 64 chars after sanitization, spaces→underscores for ProfileID)
  • Type - PMS platform type: 'RealPage' or 'Entrata' (case-sensitive)

RealPage Required Parameters:

  • RealPageURL - RealPage API endpoint URL (max 2048 chars input, validated for http/https protocol)
  • RealPageAPIKey - RealPage API authentication key (max 128 chars, sanitized to 64)
  • RealPagePMCId - RealPage property management company ID (max 128 chars, sanitized to 64)

Entrata Required Parameters:

  • EntrataAPIKey - Entrata API authentication key (max 128 characters)
  • EntrataSubdomain - Entrata account subdomain (max 128 chars, sanitized to 64)

Optional Parameters:

  • enableSync - Enable automatic PMS synchronization (boolean, default: true if omitted)
  • OperatorID - Required for NetworkSoftwareProvider role only (auto-populated for DomainAdministrator)

ProfileID Generation:

  • Format: {OperatorID}._V3PMSPROFILE_.{PROFILE_NAME_UPPERCASE}
  • Transformation: Spaces replaced with underscores, converted to uppercase
  • Example: "Downtown Properties" → "OP123._V3PMSPROFILE_.DOWNTOWN_PROPERTIES"
  • Uniqueness: Validated against existing profiles within operator

Validation Sequence:

  1. Code branch write access permission check
  2. ProfileName presence validation
  3. ProfileName length validation (max 64 chars)
  4. Type presence validation
  5. Type value validation ('Entrata' or 'RealPage' only)
  6. Type-specific required fields check
  7. RealPage URL format validation (http/https protocols)
  8. Input sanitization for all string fields
  9. ProfileName length re-check after sanitization
  10. Credential field length validation (max limits)
  11. ProfileID generation with name normalization
  12. ProfileID uniqueness check (duplicate prevention)
  13. Credential combination uniqueness check (RealPage: URL+APIKey+PMCId, Entrata: APIKey+Subdomain)
  14. Profile creation with OperatorID, ProfileName, Type, credentials, and timestamp
  15. Automatic enableSync configuration
  16. Audit log creation with event 'PMS Profile added: {ProfileID}'
  17. Response return with ProfileID

Duplicate Prevention:

  • RealPage: RealPageURL + RealPageAPIKey + RealPagePMCId combination must be unique
  • Entrata: EntrataAPIKey + EntrataSubdomain combination must be unique
  • ProfileID: Generated ProfileID must be unique within operator

Profile Data Storage:

  • Stores profile with ProfileID as unique identifier
  • Properties: OperatorID, ProfileName, Type, dateAddedUTC timestamp
  • Type-specific properties (RealPage: URL/APIKey/PMCId, Entrata: APIKey/Subdomain)
  • Records audit log entry with event 'PMS Profile added: {ProfileID}'

Processing Flow:

  1. Authentication: Validate access token via Cognito
  2. Input Validation: Parse request body, validate structure
  3. Role Identification: Determine user role and permissions
  4. OperatorID Resolution: Extract from request or authenticated context
  5. Permission Check: Verify DomainAdministrator role
  6. Profile Creation: Execute validation sequence and create profile
  7. Auto-Configuration: Apply enableSync configuration
  8. Response Return: Return ProfileID and success message
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid authentication token for network operator with domain administrator privileges and code branch write access

ProfileName
required
string [ 1 .. 128 ] characters

Unique profile name for operator (sanitized to 128 characters max)

Type
required
string
Enum: "RealPage" "Entrata"

PMS platform type - must be exactly 'RealPage' or 'Entrata'

enableSync
boolean

Enable automatic PMS synchronization (defaults to true if omitted or not explicitly false)

RealPageURL
string [ 1 .. 2048 ] characters

RealPage API endpoint URL (required for Type='RealPage', max 2048 chars input, validated for URL format with http/https protocols)

RealPageAPIKey
string [ 1 .. 128 ] characters

RealPage API authentication key (required for Type='RealPage', sanitized to 128 characters)

RealPagePMCId
string [ 1 .. 128 ] characters

RealPage property management company identifier (required for Type='RealPage', sanitized to 128 characters)

EntrataAPIKey
string [ 1 .. 128 ] characters

Entrata API authentication key (required for Type='Entrata', sanitized to 128 characters)

EntrataSubdomain
string [ 1 .. 128 ] characters

Entrata account subdomain (required for Type='Entrata', sanitized to 128 characters)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "ProfileName": "Downtown Properties",
  • "Type": "RealPage",
  • "RealPageURL": "https://api.realpage.com",
  • "RealPageAPIKey": "rp_key_abc123",
  • "RealPagePMCId": "PMC12345",
  • "enableSync": true
}

Response samples

Content type
application/json
Example
{
  • "message": "PMS Profile added successfully. PMS Profile configured successfully.",
  • "ProfileID": "OP123._V3PMSPROFILE_.DOWNTOWN_PROPERTIES",
  • "ProfileName": "Downtown Properties",
  • "Type": "RealPage"
}

/operatorconsole/config/configurePMSProfile

Update, reconfigure, or delete existing PMS (Property Management System) profiles with credential modification, enableSync control, and venue usage validation. Enforces primary region execution and provides multi-region deletion coordination.

Architecture Pattern:

  • Primary Region Enforcement - Rejects write operations in non-primary regions with "write_access_read_only" error
  • Multi-region coordination - All write operations route to primary region
  • Auto-synchronization - Changes synchronized across all regions

Required Parameters:

  • AccessToken - Network operator authentication with domain administrator privileges
  • ProfileID - Existing profile identifier to configure or delete (format: {OperatorID}._V3PMSPROFILE_.{PROFILE_NAME})

8 Configuration Operations:

  1. Update ProfileName - Rename profile (validates uniqueness within operator, sanitized to 64 chars)
  2. Update RealPage credentials - RealPageURL, RealPageAPIKey, RealPagePMCId (RealPage profiles only)
  3. Update Entrata credentials - EntrataAPIKey, EntrataSubdomain (Entrata profiles only)
  4. Toggle enableSync - Enable/disable automatic PMS synchronization
  5. Delete profile - Remove profile after venue usage validation (prevents deletion if venues connected)
  6. Combined updates - Any combination of name, credentials, and sync settings in single request
  7. Reset migration timestamps - dataMigrationCompletedDateTimeUTC and dataReplicationCompletedDateTimeUTC reset on changes
  8. Audit logging - Records changes with administrator attribution

Optional Update Parameters:

  • ProfileName - New profile name (max 128 chars, sanitized to 64, must be unique)
  • enableSync - Enable/disable automatic PMS synchronization (boolean)
  • OperatorID - Required for NetworkSoftwareProvider role only

RealPage Update Parameters (optional):

  • RealPageURL - New RealPage API endpoint URL (max 2048 chars input, validated for URL format)
  • RealPageAPIKey - New RealPage API key (max 128 characters)
  • RealPagePMCId - New RealPage PMC identifier (max 128 chars, sanitized to 64)

Entrata Update Parameters (optional):

  • EntrataAPIKey - New Entrata API key (max 128 characters)
  • EntrataSubdomain - New Entrata subdomain (max 128 chars, sanitized to 64)

Deletion Parameter:

  • delete - Set to true to permanently delete profile (boolean, default: false)

Deletion Safety:

  • Venue Usage Check - Verifies profile is not in use by any venues
  • Error if in use - Returns "PMS Profile is in use by venue(s). Cannot delete." with venue list
  • Multi-region synchronization - Ensures consistency across all regions
  • Irreversible operation - No recovery after deletion confirmation

Validation Sequence:

  1. Primary region validation (rejects if not in primary region)
  2. Code branch write access check
  3. ProfileID presence validation
  4. Profile existence check
  5. OperatorID ownership verification
  6. Change detection (at least one parameter must be provided)
  7. ProfileName uniqueness check (if changing name)
  8. ProfileName length validation after sanitization
  9. Credential combination uniqueness check (if changing credentials)
  10. Venue usage check (if delete=true)
  11. Profile update or deletion
  12. Migration timestamp reset
  13. Modification timestamp update
  14. Audit logging

Profile Data Updates:

  • Updates profile properties based on request parameters
  • Resets migration timestamps on any configuration change
  • Sets modification timestamp to current time
  • Multi-region deletion ensures consistency
  • Records audit log with detailed change tracking

Processing Flow:

  1. Authentication: Validate access token via Cognito
  2. Input Validation: Parse request body
  3. Primary Region Check: Reject if not in primary region
  4. Role Check: Verify administrator permissions
  5. ProfileID Verification: Validate ProfileID provided
  6. Profile Update/Deletion: Execute validation sequence
  7. Response Return: Return success message
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid authentication token for network operator with domain administrator privileges

ProfileID
required
string

Existing PMS profile identifier to configure or delete

ProfileName
string [ 1 .. 128 ] characters

New unique profile name (max 128 characters, sanitized to 64 characters for storage)

enableSync
boolean

Enable or disable automatic PMS synchronization

RealPageURL
string [ 1 .. 2048 ] characters

New RealPage API endpoint (RealPage profiles only, max 2048 chars input, validated for URL format with http/https protocols, sanitized to 128 characters for storage)

RealPageAPIKey
string [ 1 .. 128 ] characters

New RealPage API key (RealPage profiles only, max 128 characters, sanitized to 64 characters)

RealPagePMCId
string [ 1 .. 128 ] characters

New RealPage PMC identifier (RealPage profiles only, max 128 characters, sanitized to 64 characters)

EntrataAPIKey
string [ 1 .. 128 ] characters

New Entrata API key (Entrata profiles only, sanitized to 128 characters)

EntrataSubdomain
string [ 1 .. 128 ] characters

New Entrata subdomain (Entrata profiles only, sanitized to 64 characters)

delete
boolean

Delete profile after venue usage validation (default false)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "ProfileID": "OP123._V3PMSPROFILE_.DOWNTOWN_PROPERTIES",
  • "ProfileName": "Downtown Properties Updated"
}

Response samples

Content type
application/json
Example
{
  • "message": "PMS Profile configured successfully"
}

/operatorconsole/config/listPMSProfiles

Retrieve complete PMS (Property Management System) profile catalog with optional filtering by ProfileID, ProfileName, Type, or platform-specific credentials. Optimized for fast retrieval.

Architecture Pattern:

  • Optimized retrieval - Fast lookup with in-memory caching
  • No region forwarding - Read operations execute in any region
  • In-memory filtering - Applies multiple optional filters to profile list

Required Parameters:

  • AccessToken - Network operator authentication with domain administrator privileges

9 Filter Fields (all optional, string-only):

  1. ProfileID - Exact match on profile identifier (e.g., OperatorID._V3PMSPROFILE_.PROFILE_NAME)
  2. ProfileName - Exact match on display name
  3. Type - Filter by PMS platform type ('RealPage' or 'Entrata')
  4. enableSync - Filter by synchronization status (NOT SUPPORTED - implementation limitation)
  5. EntrataSubdomain - Filter by Entrata subdomain (Entrata profiles only)
  6. EntrataAPIKey - Filter by Entrata API key (Entrata profiles only)
  7. RealPageURL - Filter by RealPage API endpoint URL (RealPage profiles only)
  8. RealPageAPIKey - Filter by RealPage API key (RealPage profiles only)
  9. RealPagePMCId - Filter by RealPage Property Management Company ID (RealPage profiles only)

⚠️ Filtering Limitation:

  • Boolean enableSync filtering NOT supported (implementation only filters non-empty string values)
  • All filters use loose equality (==) comparison
  • Multiple filters apply AND logic (sequential filtering)
  • Empty/missing/non-string filter values are ignored

Response Data Structure:

  • PMSProfiles - Array of profile objects (empty array [] if none found)
  • SupportedTypes - Array of supported PMS platform types: ["RealPage", "Entrata"]

Profile Object Properties:

  • Common: ProfileID, ProfileName, Type, dateAddedUTC, dateModifiedUTC, enableSync
  • RealPage: RealPageURL, RealPageAPIKey, RealPagePMCId (integer)
  • Entrata: EntrataAPIKey, EntrataSubdomain
  • Defaults: enableSync defaults to false if not set, missing fields return as empty strings

Performance Characteristics:

  • Response Time: Optimized for fast retrieval
  • Filtering: O(n) complexity per filter field, executed in-memory
  • Scalability: Independent per-operator data, no cross-operator contention

Processing Flow:

  1. Authentication: Validate access token via Cognito
  2. Input Validation: Parse request body
  3. Role Check: Verify administrator permissions
  4. Profile Retrieval: Fetch operator PMS profiles
  5. Apply Filters: Sequential filtering on provided filter fields
  6. Response Enhancement: Add SupportedTypes array
  7. Return: Filtered PMSProfiles array and SupportedTypes
Authorizations:
CognitoAuth
Request Body schema: application/json
required
AccessToken
required
string

Valid authentication token for network operator with domain administrator privileges

ProfileID
string

Filter by specific profile identifier (exact string match with == comparison)

ProfileName
string

Filter by profile name (exact string match with == comparison)

Type
string
Enum: "RealPage" "Entrata"

Filter by PMS platform type (exact string match with == comparison)

EntrataSubdomain
string

Filter by Entrata subdomain (exact string match with == comparison)

EntrataAPIKey
string

Filter by Entrata API key (exact string match with == comparison)

RealPageURL
string

Filter by RealPage API URL (exact string match with == comparison)

RealPageAPIKey
string

Filter by RealPage API key (exact string match with == comparison)

RealPagePMCId
string

Filter by RealPage PMC identifier (exact string match with == comparison)

Responses

Request samples

Content type
application/json
Example
{
  • "AccessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
Example
{
  • "PMSProfiles": [
    ],
  • "SupportedTypes": [
    ]
}