Skip to main content

Get User Setting

Description​

Gets user setting via the web service.

Function Signature:​

def get_user_setting(ws_config: WebServiceConfig, setting_name: str) -> StandardResult:

Parameters​

  • ws_config (WebServiceConfig): Configuration for the web service connection.
  • setting_name (str): Setting name.

Returns​

  • StandardResult: A result object containing:
    • code: HTTP status code (200 for success, -1 for exceptions).
    • description: Response body or error message.

Example Usage​

# Example usage
ws_config = WebServiceConfig(access_key="key", secret_key="secret", base_url="https://api.example.com/")
setting_name = "example"
result = get_user_setting(ws_config, setting_name)
print(result)

Behavior​

  • Sends a signed request to the web service.
  • On success, returns the computed value or result object.

Error Handling​

  • Exceptions set the result code to -1 and include an error message when implemented.