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 code). It supports multiple resources and operations, including managing access codes. Specifically, for the "Access Code" resource and the "Delete Access Code" operation, the node allows users to delete an existing access code by specifying relevant identifiers.

Common scenarios where this node is beneficial include:

  • Automating security management tasks such as removing access codes from a system.
  • Integrating Ajax security devices or systems into workflows that require dynamic access control updates.
  • Managing user permissions programmatically within a larger automation process.

For example, a security administrator could use this node to automatically revoke access for a user who no longer requires entry, by deleting their access code based on user ID, hub ID, and access code ID.

Properties

Name Meaning
User Id The unique identifier of the user associated with the access code to be deleted.
Hub Id The unique identifier of the hub (central device or location) related to the access code.
Access Code Id The unique identifier of the specific access code to delete.

Output

The node outputs JSON data representing the result of the delete operation. This typically includes confirmation of deletion or any error messages returned by the Ajax API. The exact structure depends on the API response but generally confirms whether the access code was successfully removed.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the HttpClient class for making HTTP requests to the backend Ajax API.
  • Uses internal state and operation resolver classes to manage execution flow.
  • Requires proper configuration of the API credentials 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 will result in errors or no action.
    • Network connectivity issues can prevent successful API calls.
  • Error Messages:

    • Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
    • Not found errors suggest the specified access code or related entities do not exist; double-check input IDs.
    • General HTTP errors may require checking network status or API availability.

Links and References

Discussion