Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Receiver" resource with the "Find Paginated Receiver To Hub Bindings" operation. The node fetches paginated data about bindings between receivers and hubs, which is useful for managing or monitoring connections in systems where receivers are linked to hubs.

Common scenarios include:

  • Retrieving a list of hub bindings associated with a particular receiver within a company.
  • Paginating through large sets of receiver-to-hub binding records to process or display them incrementally.
  • Integrating with backend systems that require up-to-date information on receiver-hub relationships.

Practical example:

  • A user wants to display all hub bindings for a given receiver in their dashboard but only wants to load 20 records at a time. They can use this node to request page 1 with a page size of 20, then subsequent pages as needed.

Properties

Name Meaning
Company Id The unique identifier of the company owning the receiver.
Receiver Id The unique identifier of the receiver whose hub bindings are being queried.
Page Size The number of records to return per page in the paginated response.
Page Index The zero-based index of the page to retrieve (optional; defaults to 0 if not provided).

Output

The node outputs JSON data representing the paginated list of receiver-to-hub bindings. Each item in the output typically contains details about a single binding between a receiver and a hub, such as identifiers and possibly metadata related to the binding.

If binary data were involved, it would be summarized here, but based on the static analysis, this node primarily returns structured JSON data.

Dependencies

  • Requires an API key credential to authenticate requests against the Ajax API.
  • Depends on the external Ajax API service endpoint to fetch receiver-to-hub binding data.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution.

Troubleshooting

  • Missing or invalid credentials: Ensure that a valid API authentication token is configured in the node's credentials.
  • Invalid Company Id or Receiver Id: Verify that the provided IDs exist and are correctly formatted.
  • Page Size or Page Index errors: Page Size must be a positive integer; Page Index should be zero or greater.
  • API connectivity issues: Check network connectivity and API availability.
  • Unexpected API responses: Confirm that the API version matches the expected one and that the node is updated accordingly.

Links and References

Discussion