Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the bundled code). Specifically for the Network resource and the Enable/disable WiFi Network Channel For Company operation, it allows users to enable or disable the WiFi network channel associated with a particular company hub. This can be useful in scenarios where network administrators want to remotely control the WiFi state of company hubs, for example, turning off WiFi during maintenance windows or enabling it when needed.

Practical examples:

  • Automatically disabling WiFi channels outside business hours to improve security.
  • Enabling WiFi channels after scheduled downtime or updates.
  • Integrating with other systems to toggle WiFi based on occupancy or event triggers.

Properties

Name Meaning
Company Id The unique identifier of the company whose WiFi network channel you want to control.
Hub Id The unique identifier of the specific hub within the company where the WiFi channel is located.
State The desired state of the WiFi network channel. Options: ON to enable, OFF to disable.

Output

The node outputs JSON data representing the result of the enable/disable operation on the WiFi network channel. This typically includes confirmation of the action taken, status information, and possibly updated state details of the network channel.

If the node supports binary data output, it would relate to any raw response or logs from the Ajax API, but this is not explicitly shown in the provided code.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service to perform network operations.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution/execution.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect companyId or hubId values may lead to "not found" errors or no effect.
    • Setting an invalid state value (other than "ON" or "OFF") will likely cause validation errors.
  • Error messages:
    • Authentication errors: Verify that the API key credential is correctly configured.
    • Resource not found: Check that the company and hub IDs exist and are correct.
    • Operation failure: Ensure the Ajax API service is reachable and operational.

Resolving these usually involves verifying input parameters, checking API credentials, and ensuring network connectivity.

Links and References

Discussion