3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Holiday" operation in the Holidays resource retrieves detailed information about a specific holiday entity by its unique identifier. This node is useful when you need to fetch data about a particular holiday, such as its name, date, or related metadata, from an external system integrated via the 3CX telephony API.

Practical examples include:

  • Fetching holiday details to adjust call routing or automated responses on specific dates.
  • Retrieving holiday information for display in scheduling or calendar applications.
  • Integrating holiday data into workflows that depend on business day calculations.

Properties

Name Meaning
Id The unique numeric identifier of the holiday entity to retrieve. You can use expressions like {{$json.Id}} to dynamically specify this value.
Options A collection of optional query parameters to customize the response:
- $select Comma-separated list of properties to be returned for the holiday (e.g., Id,Name).
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the holiday entity corresponding to the specified Id. The structure includes all requested properties and any expanded related entities as defined by the $select and $expand options.

If binary data were involved (not indicated here), it would typically represent files or media associated with the holiday, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system's API.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests with headers accepting JSON responses.

Troubleshooting

  • Invalid Id: If the provided Id does not correspond to any holiday, the API may return a "Not Found" error. Verify the Id value and ensure it exists in the system.
  • Authentication errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key or OAuth token is correctly configured.
  • Malformed $select or $expand values: Incorrectly formatted option strings may result in API errors or incomplete data. Use comma-separated property names without spaces.
  • Network issues: Connectivity problems to the 3CX server will prevent data retrieval. Check network access and server URL configuration.

Links and References

Discussion