Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It provides a flexible interface to perform various operations on multiple resources related to Ajax systems, such as access codes, users, hubs, devices, and more.

For the Access Code resource with the Update Access Code Duress Password operation, the node updates the duress password associated with a particular access code. This is useful in security systems where a duress password can silently trigger an alarm or alert when entered, enhancing safety measures.

Practical examples:

  • Updating the duress password for a user's access code in a security hub.
  • Managing emergency access credentials remotely via automation workflows.
  • Integrating with security management systems to keep access control credentials up to date.

Properties

Name Meaning
User Id The identifier of the user who owns or is associated with the access code.
Hub Id The identifier of the security hub where the access code is registered.
Access Code Id The unique identifier of the access code whose duress password is being updated.
New Password The new duress password to set; must be a 4-6 digit numeric code.

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation of the update, status information, and possibly the updated access code details.

If the node supports binary data output, it would relate to any files or media returned by the Ajax API, but based on the provided code and context, the primary output is structured JSON reflecting the operation's success or failure.

Dependencies

  • Requires an API key credential to authenticate with the Ajax API service.
  • Depends on internal modules handling HTTP requests, state management, and operation resolution/execution.
  • Needs proper configuration of the API credential within n8n to function correctly.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing incorrect or non-existent User Id, Hub Id, or Access Code Id may result in errors or no changes.
    • The new password must be 4-6 digits; invalid formats might be rejected by the API.
  • Error messages:

    • Authentication errors indicate problems with the API key setup.
    • Validation errors suggest input parameters do not meet required formats or constraints.
    • Network or timeout errors could occur if the Ajax API service is unreachable.
  • Resolutions:

    • Verify that the API key credential is correctly configured and active.
    • Double-check all input IDs and ensure they exist in the system.
    • Ensure the new password complies with the 4-6 digit requirement.
    • Confirm network connectivity and API endpoint availability.

Links and References

Discussion