Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

The node named "Ajax" is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Access Control" resource with an operation called "Exit Card Mode." This node enables users to programmatically control access-related features within the Ajax system, such as managing user card modes.

A common use case for the "Exit Card Mode" operation under the "Access Control" resource would be to remotely disable or exit a user's card mode on a specific hub. For example, security administrators can automate disabling card access for a user when their access rights change or when they leave a facility.

Properties

Name Meaning
User Id The unique identifier of the user whose card mode should be exited.
Hub Id The unique identifier of the hub where the card mode exit action will be performed.

These properties are required inputs for the "Exit Card Mode" operation under the "Access Control" resource.

Output

The node outputs JSON data representing the result of the API call to exit card mode for the specified user and hub. The exact structure depends on the Ajax API response but typically includes status information about the success or failure of the operation.

If the node supports binary data output, it would relate to any binary content returned by the Ajax API, but based on the provided code and context, the primary output is JSON.

Dependencies

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

Troubleshooting

  • Common Issues:

    • Invalid or missing User Id or Hub Id parameters will cause the operation to fail.
    • Authentication errors if the API key credential is incorrect or expired.
    • Network connectivity issues preventing access to the Ajax API endpoint.
    • API rate limits or permission restrictions from the Ajax backend.

  • Error Messages:

    • Authentication failures typically indicate invalid credentials; verify and update the API key.
    • Parameter validation errors suggest missing or malformed input properties; ensure User Id and Hub Id are correctly set.
    • Timeout or network errors require checking internet connectivity and API availability.

Links and References

Discussion