BadGatewayException.md

BadGatewayException

Module: bamboohr_sdk.exceptions Extends: ServerException HTTP Status Code: 502

Description

Bad gateway

Usage

from bamboohr_sdk.exceptions import BadGatewayException

try:
    # API call that might fail with 502 status code
    client.employees().get_employees_directory()
except BadGatewayException as e:
    # Handle the exception
    print(e)

    # Access additional information
    causes = e.potential_causes()
    tips = e.debugging_tips()

    # Access response data
    print(f"Status: {e.status}")
    print(f"Request ID: {e.request_id}")
    if e.body:
        print(f"Response body: {e.body}")

Potential Causes

• The server received an invalid response from an upstream server
• Proxy or gateway configuration issues
• Temporary communication failure between servers

Debugging Tips

• Retry the request after a delay
• Implement automatic retry logic with backoff
• Check if the service is experiencing known issues
• Verify network connectivity between your client and the API

Constructor

BadGatewayException(
    status=None,
    reason=None,
    http_resp=None,
    *,
    body: str | None = None,
    data: Any | None = None,
    request_id: str | None = None,
)

Parameters

Name	Type	Description
status	int | None	HTTP status code
reason	str | None	HTTP reason phrase
http_resp	RESTResponse | None	The raw HTTP response object
body	str | None	HTTP response body
data	Any | None	Deserialized response data
request_id	str | None	Request ID from response headers

Methods

potential_causes()

Returns a list of potential causes for this exception.

@staticmethod
def potential_causes() -> list[str]

debugging_tips()

Returns a list of debugging tips for this exception.

@staticmethod
def debugging_tips() -> list[str]