Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to retrieve data related to various resources, including roles. Specifically, for the 'Roles' resource and 'Get All Roles' operation, it fetches a list of roles from the API. It supports filtering, sorting, and pagination through input options such as limit, offset, search, and sort. This node is useful for scenarios where users need to programmatically access and manage role data from the Billing Booth One system, for example, to synchronize roles with another system or to generate reports.

Use Case Examples

  1. Retrieve all roles with a limit of 10 entries.
  2. Search roles by name with pagination support.
  3. Sort roles by name in ascending or descending order.

Properties

Name Meaning
Limit Maximum number of role entries to return, used for pagination.
Offset Starting offset for the list of roles, used for pagination.
Search Search term to filter roles by name.
Sort Sort order of the results, supports multiple comma-separated values such as 'name' or '-name' for descending order.

Output

JSON

  • json - The JSON response from the Billing Booth One API containing the list of roles and their details.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Common issues include missing or invalid API credentials, resulting in authentication errors.
  • Incorrect or unsupported query parameters may cause the API to return errors or empty results.
  • Network connectivity issues can prevent successful API requests.
  • Error messages from the node typically include the API error message or a generic 'Unknown error occurred' message. Users should verify credentials, parameter values, and network status to resolve issues.

Discussion